diff --git a/docs/Configuration.md b/docs/Configuration.md index 7fb14f5c17c363fd3961f1a087e9c83a0ab4f23a..c7e5761b38ccc71166b1ca483dfed38039faf774 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,4 +1,23 @@ # Configuration -Dependency injection is used for configuration using the ```dependency_injector``` package. -Configuration files can be in json or ini format. \ No newline at end of file +Models can be serialized as a ```json``` file with the following structure: + +```json +{ + "model": { + "type": <model_type>, + "parameters": { + <parameter_name>: { + "type": <class_name>, + "parameters": {...} + } + } + } +} +``` + +The ```"type"``` field serves as a dependency-injection like mechanism and +sets which class and constructor is used. +The ```"parameters"``` dictionary is passed to the constructor method. Every +parameter is attempted to be resolved from the class registry and only if that's +not possible they are passed as-is. \ No newline at end of file