diff --git a/README.md b/README.md index 7417c2e6549700a607334a144920ac977b4741cb..1198c6ae377519ae595e2609b053eb91a7bba01e 100644 --- a/README.md +++ b/README.md @@ -308,7 +308,7 @@ class MyCustomisedModel(AbstractModelClass): self.compile_options = {"optimizer" = keras.optimizers.Adam()} ``` -### How to plug in the customised model into the workflow? +## How to plug in the customised model into the workflow? * Make use of the `model` argument and pass `MyCustomisedModel` when instantiating a workflow. ```python from mlair.workflows import DefaultWorkflow diff --git a/docs/_source/customise.rst b/docs/_source/customise.rst index 3d3873cb6c08d0ad6bfcfeda0fe415807252bfff..cb77eb63f8bf1a53d54ca2e0f80fd9bdeb93a0b0 100644 --- a/docs/_source/customise.rst +++ b/docs/_source/customise.rst @@ -143,6 +143,20 @@ How to create a customised model? self.compile_options = {"optimizer" = keras.optimizers.Adam()} +How to plug in the customised model into the workflow? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* Make use of the :py:`model` argument and pass :py:`MyCustomisedModel` when instantiating a workflow. + + +.. code-block:: python + + from mlair.workflows import DefaultWorkflow + + workflow = DefaultWorkflow(model=MyCustomisedModel) + workflow.run() + + Specials for Branched Models ~~~~~~~~~~~~~~~~~~~~~~~~~~~~