Nested sampling-based optimization of representation. More...

Detailed Description

Nested sampling-based optimization of representation.

NestOR: Nested Sampling-based Optimization of Representation for Integrative Structural Modeling

Python module to perform Nested Sampling-based optimization of representation for integrative structural modeling

Publication and Data

Shreyas Arvindekar, Aditi S Pathak, Kartik Majila, Shruthi Viswanath, Optimizing representations for integrative structural modeling using Bayesian model selection, Bioinformatics, 40(3), btae106, 2024, at DOI. Data is deposited in Zenodo

Dependencies:

See requirements.txt for Python dependencies

Running NestOR

Inputs

(See also examples/)

We need to split the input restraints into two subsets: one for sampling and one for evidence calculation. We recommend 30% of input crosslinks for the sampling subset, and the rest of the crosslinks and all the EM and other restraints for the evidence calculation subset. Use this helper script to split the input crosslinks into the sampling and evidence calculation subsets: python -m IMP.nestor.xl_datasplitter {path} where, path refers to the path of the target crosslinking file.
Make the modeling script in the form as shown in the examples/modeling.py. One will also need to make separate topology files for different candidate representations. Make sure that the restraints that are to be used to inform the likelihood have weight=0, and these are added to a separate list that is passed to the replica exchange macro as nestor_restraints argument. Ensure the modeling script looks similar to the one in example/. Specifically, ensure that the modeling instructions are enclosed in a function that is called so that the terminal stdout of the modeling is not returned to the terminal. One can use contextlib as shown in the example.
Set appropriate parameters in the nestor_params.yaml file.

Run command

Run the NestOR wrapper as follows:

python -m IMP.nestor.wrapper_v6 -p {nestor_param_path}

where, nestor_param_path refers to the absolute path to the nestor_params.yamlfile. If using topology file for representing the system, use -t flag. This flag can be ommitted if the representation is defined in the modeling script. If only the plotting functionalities of NestOR are to be used, run the above command with -s flag.

Note One NestOR run corresponds to the set of all nested sampling runs for all candidate representations._ One can also compare results from NestOR runs with different parameter settings by running python -m IMP.nestor.compare_runs_v2_w_pyplot {comparison_title} run_set1 run_set2 ... where comparison_title is the title for the runs to be compared, run_set1 and run_set2 are the NestOR runs to be compared.

Outputs

Plots

Step 1 in the Run command above, i.e. one NestOR run generates these plots:

Evidence: The plot (*_params_evidence_errorbarplot.png) shows the mean values of evidence for all the candidate representations along with errorbars showing the standard error on the mean.
MCMC per-step time: The plot (*_params_persteptime.png) shows the time required to sample one MCMC step per run. This is computed as (time taken for iteration 0)/((number of initial frames)*(number of MCMC steps per frame))
Evidence and MCMC per-step time per representation : The plot (*sterr_evi_and_proctime.png) compares evidences and their sampling efficiency across representations.

Output YAML file

This file is generated upon completion of step 1 in the Run command above.

Choice of NestOR parameters

Evidence related:

log_estimated_evidence: float The estimated evidence value represented as natural logarithm of the estimated evidence
obtained_information: float Information obtained from the nested sampling run
analytical_uncertainty: float The analytical uncertainty associated with evidence estimation for a run by nested sampling

Efficiency related

mcmc_step_time: float Time taken per MCMC step. This is computed as (time taken for iteration 0)/((number of initial frames)*(number of MCMC steps per frame))
nestor_process_time: float Wall clock time taken by a nested sampling run to finish, represented in seconds

Termination related

exit_code: int (0, 11, 12, 13) Exit code for a nested sampling run
termination_mode: str Cause for run termination
failed_iter: int Number of times Replica Exchange failed to obtain a sample from constrained prior in the current iteration of nested sampling
last_iter: int Iteration count (number of iterations) when nested sampling terminated
plateau_hits: int Number of consecutive times the nested sampling protocol detected a plateau in the estimated evidence

Exit codes:

Exit code 0: Run terminated normally.
Exit code 11: Run terminated due to either a shuffle configuration error or NaN was encountered in the likelihoods. The run will be restarted automatically.
Exit code 12: Run terminated as NestOR ran out of maximum allowed iterations. The run will not be restarted.
Exit code 13: Run terminated due to Math domain error in analytical uncertainty calculation. This happened probably because the run terminated too early resulting in a negative value for H.

If a run terminates with exit code = 12, the run is considered incomplete (and is not rerun) and its results are not considered valid, i.e. these are not plotted and not used to infer optimal representation. Results from runs with exit codes 0 and 13 are used to infer the optimal representation.

Information

Author(s): Shreyas Arvindekar, Shruthi Viswanath

Date: April 7th, 2023

License: CC BY-SA 4.0 This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Last known good IMP version: not tested

Testable: Yes

Parallelizeable: Yes

Publications: Arvindekar, S., et. al. Optimizing representations for integrative structural modeling using bayesian model selection, Bioinformatics, 40(3), btae106, 2024. DOI: 10.1093/bioinformatics/btae106.

Namespaces
	compare_runs_v2_w_pyplot
	Plotting script to compare NestOR runs.

	wrapper_v6
	Top-level NestOR script.

	xl_datasplitter
	Script to split a CSV file for use in nested sampling.

Functions
def	get_data_path
	Return the full path to one of this module's data files. More...

def	get_example_path
	Return the full path to one of this module's example files. More...

def	get_module_name
	Return the fully-qualified name of this module. More...

def	get_module_version
	Return the version of this module, as a string. More...

Function Documentation

def IMP.nestor.get_data_path ( fname )

Return the full path to one of this module's data files.

Note: This function is only available in Python.

Definition at line 359 of file nestor/__init__.py.

def IMP.nestor.get_example_path ( fname )

Return the full path to one of this module's example files.

Note: This function is only available in Python.

Definition at line 364 of file nestor/__init__.py.

def IMP.nestor.get_module_name ( )

Return the fully-qualified name of this module.

Note: This function is only available in Python.

Definition at line 354 of file nestor/__init__.py.

def IMP.nestor.get_module_version ( )

Return the version of this module, as a string.

Note: This function is only available in Python.

Definition at line 349 of file nestor/__init__.py.