File tree 2 files changed +10
-2
lines changed
2 files changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -122,7 +122,10 @@ def get_metadata(self):
122
122
"version": "Model version",
123
123
}
124
124
125
- The only fields that are mandatory are 'description' and 'name'.
125
+ If you want to integrate with the deephdc platform you should
126
+ provide at least an [``name``, ``author``, ``author-email``,
127
+ ``license``]. You can nevertheless set them to ``None``
128
+ if you don't feel like providing the information.
126
129
127
130
The schema that we are following is the following::
128
131
@@ -203,7 +206,8 @@ def train(self, **kwargs):
203
206
able to pass them down. Usually you would populate these with all
204
207
the training hyper-parameters
205
208
206
- :return: TBD
209
+ :return: You can return any Python object that is JSON parseable
210
+ (eg. dict, string, float).
207
211
"""
208
212
raise NotImplementedError ()
209
213
Original file line number Diff line number Diff line change @@ -13,6 +13,10 @@ Integrating a model into the V2 API (CURRENT)
13
13
API version was ``1.0.0 ``. Please do not be confused with the ``deepaas ``
14
14
`release ` (i.e. ``0.5.2 ``, ``1.0.0 ``) and the DEEPaaS API version (V1 or V2).
15
15
16
+ If you want to see an example of a module integrated with deepaas, where those
17
+ methods are actually implemented, please head over to the
18
+ `deephdc demo app <https://github.com/deephdc/demo_app >`__.
19
+
16
20
Defining what to load
17
21
---------------------
18
22
You can’t perform that action at this time.
0 commit comments