Skip to content

Commit e7e1105

Browse files
IgnacioHerediaalvarolopez
authored andcommitted
update the docs
1 parent fba9810 commit e7e1105

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

deepaas/model/v2/base.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,10 @@ def get_metadata(self):
122122
"version": "Model version",
123123
}
124124
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.
126129
127130
The schema that we are following is the following::
128131
@@ -203,7 +206,8 @@ def train(self, **kwargs):
203206
able to pass them down. Usually you would populate these with all
204207
the training hyper-parameters
205208
206-
:return: TBD
209+
:return: You can return any Python object that is JSON parseable
210+
(eg. dict, string, float).
207211
"""
208212
raise NotImplementedError()
209213

doc/source/user/v2-api.rst

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Integrating a model into the V2 API (CURRENT)
1313
API version was ``1.0.0``. Please do not be confused with the ``deepaas``
1414
`release` (i.e. ``0.5.2``, ``1.0.0``) and the DEEPaaS API version (V1 or V2).
1515

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+
1620
Defining what to load
1721
---------------------
1822

0 commit comments

Comments
 (0)