Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptive nsegs #47

Open
wants to merge 19 commits into
base: develop
Choose a base branch
from
Open

Adaptive nsegs #47

wants to merge 19 commits into from

Conversation

jeremyleung521
Copy link
Owner

Issue Number

Describe the changes made

This PR allows one to dynamically adjust the bin target count (target number of segments per bin) with a multiplier.
This multiplier can be determined in two different ways and is always capped by max_target_count_multiplier:

  • Sample Density: Adjust target count based on "sample density", which is a value dictating the number of segments/unit progress coordinate volume. ("volume" in terms of progress coordinate dimensions. It could effectively be "length" for 1D PC, "area" for 2D PC etc.)
  • Total number of segments: Adjust target count such that it's as close to the maximum number of trajectories per simulation (n_bins * segments_per_bin).

These two cannot used simultaneously.

To turn this on, you can use the following options.

west:
  system:
    system_options:
      # Number walkers per bin
      bin_target_counts: 5
      sample_density: False  # Turn this on to adjust based on sample density
      ideal_sample_density: 25  # Number of segments per PC unit volume
      force_max_target_counts: True  # Turn this on to adjust based on target count
      max_target_count_multiplier: 3  # Cap out how large the multiplier can be.

Goals and Outstanding Issues

  • [ ]

Major files changed

  • [ ]

Status

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant