ProjectIoInterface
- class glotaran.io.interface.ProjectIoInterface(format_name: str)[source]
Bases:
object
Baseclass for Project IO plugins.
Initialize a Project IO plugin with the name of the format.
- Parameters
format_name (str) – Name of the supported format an instance uses.
Methods Summary
Create a Model instance from the specs defined in a file (NOT IMPLEMENTED).
Create a ParameterGroup instance from the specs defined in a file (NOT IMPLEMENTED).
Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).
Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).
Save a Model instance to a spec file (NOT IMPLEMENTED).
Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).
Save a Result instance to a spec file (NOT IMPLEMENTED).
Save a Scheme instance to a spec file (NOT IMPLEMENTED).
Methods Documentation
- load_model(file_name: str) Model [source]
Create a Model instance from the specs defined in a file (NOT IMPLEMENTED).
- load_parameters(file_name: str) ParameterGroup [source]
Create a ParameterGroup instance from the specs defined in a file (NOT IMPLEMENTED).
- Parameters
file_name (str) – File containing the parameter specs.
- Returns
ParameterGroup instance created from the file.
- Return type
- load_result(result_path: str) Result [source]
Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).
- load_scheme(file_name: str) Scheme [source]
Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).
- Parameters
file_name (str) – File containing the parameter specs.
- Returns
Scheme – Scheme instance created from the file.
.. # noqa (DAR202)
.. # noqa (DAR401)
- save_model(model: Model, file_name: str)[source]
Save a Model instance to a spec file (NOT IMPLEMENTED).
- save_parameters(parameters: ParameterGroup, file_name: str)[source]
Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).
- Parameters
parameters (ParameterGroup) – ParameterGroup instance to save to specs file.
file_name (str) – File to write the parameter specs to.