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

Clarify n_bootstraps docstring #549

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ jobs:
condarc: |
channels:
- conda-forge
- defaults
create-args: >-
python=${{ matrix.python-version }}

Expand Down Expand Up @@ -110,14 +109,15 @@ jobs:
uses: actions/checkout@v1

- name: Setup Conda via Mamba
uses: mamba-org/provision-with-micromamba@main
uses: mamba-org/setup-micromamba@v1
with:
environment-file: devtools/conda-envs/test_env.yaml
environment-name: test
channels: conda-forge,defaults
extra-specs: |
condarc: |
channels:
- conda-forge
create-args: >-
python=${{ matrix.python-version }}

- name: Install linter and formatter
shell: bash -l {0}
run: |
Expand Down
5 changes: 2 additions & 3 deletions pymbar/mbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,8 @@ def __init__(
samples from the 1st state, and so forth.

n_bootstraps: int
How many bootstrap free energies will be computed? If None, no bootstraps will be computed.
computing uncertainties with bootstraps is only possible if this is > 0.
(default: None)
The number of bootstrap resamples to compute. If 0, no bootstrapping will be
carried out and computing uncertainties with bootstraps will not be possible (default: 0).

bootstrap_solver_protocol: list(dict), string or None, optional, default=None
We usually just do steps of adaptive sampling without. "robust" would be the backup.
Expand Down
Loading