Package ReferenceΒΆ
- kliff.analyzers
- kliff.analyzers.fisher
- kliff.analyzers.rmse
- kliff.atomic_data
- kliff.dataset
ConfigurationConfiguration.from_file()Configuration.to_file()Configuration.from_colabfit()Configuration.to_colabfit()Configuration.from_ase_atoms()Configuration.to_ase_atoms()Configuration.cellConfiguration.PBCConfiguration.speciesConfiguration.coordsConfiguration.energyConfiguration.forcesConfiguration.stressConfiguration.weightConfiguration.identifierConfiguration.fingerprintConfiguration.pathConfiguration.metadataConfiguration.get_num_atoms()Configuration.get_num_atoms_by_species()Configuration.get_volume()Configuration.count_atoms_by_species()Configuration.order_by_species()Configuration.to_dict()Configuration.bulk()Configuration.get_supercell()
DatasetDataset.from_colabfit()Dataset.add_from_colabfit()Dataset.from_path()Dataset.add_from_path()Dataset.from_ase()Dataset.add_from_ase()Dataset.from_lmdb()Dataset.add_from_lmdb()Dataset.to_lmdb()Dataset.from_huggingface()Dataset.add_from_huggingface()Dataset.to_path()Dataset.to_ase()Dataset.to_ase_list()Dataset.to_colabfit()Dataset.get_configs()Dataset.save_weights()Dataset.add_weights()Dataset.add_metadata()Dataset.get_metadata()Dataset.metadataDataset.check_properties_consistency()Dataset.get_manifest_checksum()Dataset.get_dataset_from_manifest()
read_extxyz()write_extxyz()
- kliff.dataset.configuration
ConfigurationConfiguration.from_file()Configuration.to_file()Configuration.from_colabfit()Configuration.to_colabfit()Configuration.from_ase_atoms()Configuration.to_ase_atoms()Configuration.cellConfiguration.PBCConfiguration.speciesConfiguration.coordsConfiguration.energyConfiguration.forcesConfiguration.stressConfiguration.weightConfiguration.identifierConfiguration.fingerprintConfiguration.pathConfiguration.metadataConfiguration.get_num_atoms()Configuration.get_num_atoms_by_species()Configuration.get_volume()Configuration.count_atoms_by_species()Configuration.order_by_species()Configuration.to_dict()Configuration.bulk()Configuration.get_supercell()
ConfigurationError
- kliff.dataset.dataset
DatasetDataset.from_colabfit()Dataset.add_from_colabfit()Dataset.from_path()Dataset.add_from_path()Dataset.from_ase()Dataset.add_from_ase()Dataset.from_lmdb()Dataset.add_from_lmdb()Dataset.to_lmdb()Dataset.from_huggingface()Dataset.add_from_huggingface()Dataset.to_path()Dataset.to_ase()Dataset.to_ase_list()Dataset.to_colabfit()Dataset.get_configs()Dataset.save_weights()Dataset.add_weights()Dataset.add_metadata()Dataset.get_metadata()Dataset.metadataDataset.check_properties_consistency()Dataset.get_manifest_checksum()Dataset.get_dataset_from_manifest()
DatasetError
- kliff.dataset.dataset_torch
- kliff.dataset.extxyz
- kliff.dataset.weight
- kliff.error
- kliff.legacy
- kliff.legacy.calculators
CalculatorCalculator.create()Calculator.get_compute_arguments()Calculator.compute()Calculator.get_energy()Calculator.get_forces()Calculator.get_stress()Calculator.get_prediction()Calculator.get_reference()Calculator.get_opt_params()Calculator.get_num_opt_params()Calculator.opt_params_has_bounds()Calculator.get_opt_params_bounds()Calculator.update_model_params()
CalculatorTorchCalculatorTorch.implemented_propertyCalculatorTorch.create()CalculatorTorch.get_fingerprints()CalculatorTorch.get_compute_arguments()CalculatorTorch.set_fingerprints()CalculatorTorch.fit()CalculatorTorch.compute()CalculatorTorch.modelCalculatorTorch.save_model()CalculatorTorch.get_energy()CalculatorTorch.get_forces()CalculatorTorch.get_stress()CalculatorTorch.get_size_opt_params()CalculatorTorch.get_num_opt_params()CalculatorTorch.get_opt_params()CalculatorTorch.update_model_params()
- kliff.legacy.calculators.calculator
CalculatorCalculator.create()Calculator.get_compute_arguments()Calculator.compute()Calculator.get_energy()Calculator.get_forces()Calculator.get_stress()Calculator.get_prediction()Calculator.get_reference()Calculator.get_opt_params()Calculator.get_num_opt_params()Calculator.opt_params_has_bounds()Calculator.get_opt_params_bounds()Calculator.update_model_params()
CalculatorError
- kliff.legacy.calculators.calculator_torch
CalculatorTorchCalculatorTorch.implemented_propertyCalculatorTorch.create()CalculatorTorch.get_fingerprints()CalculatorTorch.get_compute_arguments()CalculatorTorch.set_fingerprints()CalculatorTorch.fit()CalculatorTorch.compute()CalculatorTorch.modelCalculatorTorch.save_model()CalculatorTorch.get_energy()CalculatorTorch.get_forces()CalculatorTorch.get_stress()CalculatorTorch.get_size_opt_params()CalculatorTorch.get_num_opt_params()CalculatorTorch.get_opt_params()CalculatorTorch.update_model_params()
CalculatorTorchSeparateSpeciesCalculatorTorchError
- kliff.legacy.descriptors
DescriptorDescriptor.sizeDescriptor.meanDescriptor.stdevDescriptor.generate_fingerprints()Descriptor.transform()Descriptor.write_kim_params()Descriptor.get_size()Descriptor.get_mean()Descriptor.get_stdev()Descriptor.get_dtype()Descriptor.get_cutoff()Descriptor.get_hyperparams()Descriptor.state_dict()Descriptor.load_state_dict()
- kliff.legacy.descriptors.bispectrum
- kliff.legacy.descriptors.bispectrum.bispectrum
- kliff.legacy.descriptors.descriptor
DescriptorDescriptor.sizeDescriptor.meanDescriptor.stdevDescriptor.generate_fingerprints()Descriptor.transform()Descriptor.write_kim_params()Descriptor.get_size()Descriptor.get_mean()Descriptor.get_stdev()Descriptor.get_dtype()Descriptor.get_cutoff()Descriptor.get_hyperparams()Descriptor.state_dict()Descriptor.load_state_dict()
load_fingerprints()generate_full_cutoff()generate_unique_cutoff_pairs()generate_species_code()DescriptorError
- kliff.legacy.descriptors.symmetry_function
- kliff.legacy.descriptors.symmetry_function.sym_fn
- kliff.legacy.loss
- kliff.legacy.nn
- kliff.log
- kliff.models
ParameterParameter.nameParameter.transform_functionParameter.indexParameter.boundsParameter.opt_maskParameter.nameParameter.transform_functionParameter.indexParameter.boundsParameter.opt_maskParameter.transform()Parameter.inverse_transform()Parameter.copy_from_param_space()Parameter.copy_from_model_space()Parameter.get_numpy_array_model_space()Parameter.get_numpy_array_param_space()Parameter.get_opt_numpy_array_param_space()Parameter.copy_at_param_space()Parameter.add_transform()Parameter.add_bounds_model_space()Parameter.add_bounds_param_space()Parameter.add_opt_mask()Parameter.get_bounds_param_space()Parameter.get_bounds_model_space()Parameter.has_bounds()Parameter.as_dict()Parameter.save()Parameter.from_dict()Parameter.load()Parameter.get_opt_param_name_value_and_indices()Parameter.lower_boundParameter.upper_boundParameter.is_mutable
ComputeArgumentsModelModel.init_model_params()Model.init_influence_distance()Model.init_supported_species()Model.get_compute_argument_class()Model.write_kim_model()Model.get_influence_distance()Model.get_supported_species()Model.get_model_params()Model.echo_model_params()Model.read_opt_params()Model.set_params_mutable()Model.set_opt_params()Model.set_one_opt_param()Model.echo_opt_params()Model.get_num_opt_params()Model.get_opt_params()Model.update_model_params()Model.get_opt_param_name_value_and_indices()Model.get_formatted_param_bounds()Model.opt_params_has_bounds()Model.save()Model.load()Model.named_parameters()Model.parameters()
LennardJonesKIMModelKIMModel.init_model_params()KIMModel.init_influence_distance()KIMModel.init_supported_species()KIMModel.get_compute_argument_class()KIMModel.get_kim_model_params()KIMModel.create_a_kim_compute_argument()KIMModel.set_params_mutable()KIMModel.set_one_opt_param()KIMModel.update_model_params()KIMModel.write_kim_model()KIMModel.get_model_from_manifest()KIMModel.get_model_driver_name()
ModelTorchNeuralNetworkLinearRegression
- kliff.models.kim
KIMComputeArgumentsKIMModelKIMModel.init_model_params()KIMModel.init_influence_distance()KIMModel.init_supported_species()KIMModel.get_compute_argument_class()KIMModel.get_kim_model_params()KIMModel.create_a_kim_compute_argument()KIMModel.set_params_mutable()KIMModel.set_one_opt_param()KIMModel.update_model_params()KIMModel.write_kim_model()KIMModel.get_model_from_manifest()KIMModel.get_model_driver_name()
KIMModelError
- kliff.models.lennard_jones
- kliff.models.linear_regression
- kliff.models.model
ComputeArgumentsModelModel.init_model_params()Model.init_influence_distance()Model.init_supported_species()Model.get_compute_argument_class()Model.write_kim_model()Model.get_influence_distance()Model.get_supported_species()Model.get_model_params()Model.echo_model_params()Model.read_opt_params()Model.set_params_mutable()Model.set_opt_params()Model.set_one_opt_param()Model.echo_opt_params()Model.get_num_opt_params()Model.get_opt_params()Model.update_model_params()Model.get_opt_param_name_value_and_indices()Model.get_formatted_param_bounds()Model.opt_params_has_bounds()Model.save()Model.load()Model.named_parameters()Model.parameters()
ModelError
- kliff.models.model_torch
- kliff.models.neural_network
- kliff.models.parameter
ParameterParameter.nameParameter.transform_functionParameter.indexParameter.boundsParameter.opt_maskParameter.nameParameter.transform_functionParameter.indexParameter.boundsParameter.opt_maskParameter.transform()Parameter.inverse_transform()Parameter.copy_from_param_space()Parameter.copy_from_model_space()Parameter.get_numpy_array_model_space()Parameter.get_numpy_array_param_space()Parameter.get_opt_numpy_array_param_space()Parameter.copy_at_param_space()Parameter.add_transform()Parameter.add_bounds_model_space()Parameter.add_bounds_param_space()Parameter.add_opt_mask()Parameter.get_bounds_param_space()Parameter.get_bounds_model_space()Parameter.has_bounds()Parameter.as_dict()Parameter.save()Parameter.from_dict()Parameter.load()Parameter.get_opt_param_name_value_and_indices()Parameter.lower_boundParameter.upper_boundParameter.is_mutable
ParameterError
- kliff.neighbor
- kliff.neighbor.neighbor
- kliff.parallel
- kliff.trainer
- kliff.trainer.base_trainer
TrainerTrainer.parse_manifest()Trainer.config_to_dict()Trainer.from_file()Trainer.get_trainer_hash()Trainer.initialize()Trainer.seed_all()Trainer.setup_workspace()Trainer.setup_dataset()Trainer.save_config()Trainer.setup_dataset_transforms()Trainer.setup_model()Trainer.setup_parameter_transforms()Trainer.setup_optimizer()Trainer.setup_dataset_split()Trainer.log_per_atom_outputs()Trainer.loss()Trainer.checkpoint()Trainer.train_step()Trainer.validation_step()Trainer.get_optimizer()Trainer.train()Trainer.save_kim_model()Trainer.write_training_env_edn()
TrainerError
- kliff.trainer.kim_trainer
- kliff.trainer.lightning_trainer
- kliff.trainer.torch_trainer
DNNTrainerDNNTrainer.setup_optimizer()DNNTrainer.loss()DNNTrainer.checkpoint()DNNTrainer.load_checkpoint()DNNTrainer.get_last_checkpoint()DNNTrainer.train_step()DNNTrainer.validation_step()DNNTrainer.train()DNNTrainer.setup_model()DNNTrainer.save_kim_model()DNNTrainer.setup_dataloaders()DNNTrainer.setup_parameter_transforms()
- kliff.trainer.utils
- kliff.trainer.utils.dataloaders
- kliff.trainer.utils.lightning_utils
- kliff.trainer.utils.losses
- kliff.transforms
- kliff.transforms.configuration_transforms
- kliff.transforms.configuration_transforms.configuration_transform
- kliff.transforms.configuration_transforms.default_hyperparams
- kliff.transforms.configuration_transforms.descriptor_initializers
- kliff.transforms.configuration_transforms.descriptors
- kliff.transforms.configuration_transforms.graphs
- kliff.transforms.configuration_transforms.graphs.generate_graph
- kliff.transforms.configuration_transforms.utils
- kliff.transforms.parameter_transforms
- kliff.transforms.property_transforms
- kliff.uq
- kliff.uq.bootstrap
- kliff.uq.mcmc
- kliff.uq.mcmc_utils
- kliff.utils
length_equal()torch_available()torch_geometric_available()split_string()seed_all()to_path()download_dataset()create_directory()yaml_dump()yaml_load()pickle_dump()pickle_load()stress_to_voigt()stress_to_tensor()is_kim_model_installed()install_kim_model()get_n_configs_in_xyz()str_to_numpy()