From 683ba759ae10b4f1e86cc07a8879909f39ea781c Mon Sep 17 00:00:00 2001
From: leufen1 <l.leufen@fz-juelich.de>
Date: Thu, 24 Sep 2020 11:43:24 +0200
Subject: [PATCH] added how to plugin custom model to docs too
---
README.md | 2 +-
docs/_source/customise.rst | 14 ++++++++++++++
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7417c2e6..1198c6ae 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 3d3873cb..cb77eb63 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
GitLab