schrodinger.application.transforms.scorers.ffbuilder module¶
FFBuilder preprocessor for AL-Pareto scorers.
Generates missing force field parameters before scoring by running the
RunFFBuilder transform over the incoming structures.
- class schrodinger.application.transforms.scorers.ffbuilder.FFBuilderPreprocessorConfig(*, input_opls_dir: pathlib.Path | None = None, output_opls_dir: ~pathlib.Path, cli_args: list[str] = <factory>, host: str | None = None, schrodinger_path: str = <factory>, additional_inputs: list[pathlib.Path] = <factory>)¶
Bases:
FFBuilderConfigConfiguration for the
FFBuilderPreprocessor.- Parameters:
additional_inputs – Paths to structure files whose contents are added to the structures fed to ffbuilder
- additional_inputs: list[pathlib.Path]¶
- model_config: ClassVar[ConfigDict] = {'frozen': True}¶
Configuration for the model, should be a dictionary conforming to [
ConfigDict][pydantic.config.ConfigDict].
- class schrodinger.application.transforms.scorers.ffbuilder.FFBuilderPreprocessor(**kwargs)¶
Bases:
BasePreprocessorGenerate missing force field parameters before scoring.
Runs ffbuilder over the incoming structures (and any
additional_inputs) and passes the original structures through unchanged, gated on the ffbuilder run’s completion.- PREPROCESSOR_ID: str = 'ffbuilder'¶
- config_class¶
alias of
FFBuilderPreprocessorConfig
- __init__(**kwargs)¶
Initialize the transform with configuration.
All keyword arguments are passed to the config_class constructor to create a validated configuration instance stored as self.config.
- Parameters:
kwargs – Configuration parameters for the config_class
- Raises:
AttributeError – If config_class is not defined on the subclass
ValidationError – If the configuration parameters are invalid
- expand(structures)¶