Skip to content

Commit f2b569b

Browse files
committed
Issue #278: make sure inherited methods are shown on DataCube/VectorCune/... docs
1 parent 4321766 commit f2b569b

File tree

2 files changed

+32
-6
lines changed

2 files changed

+32
-6
lines changed

docs/api.rst

+28-5
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,47 @@ of using a web service, so the user can produce concise and readable code.
1212
Users that want to interact with OpenEO on a lower level, and have more control, can
1313
use the lower level classes.
1414

15+
16+
openeo
17+
--------
18+
1519
.. autofunction:: openeo.connect
1620

1721

1822
openeo.rest.datacube
19-
----------------------------------
23+
-----------------------
2024

2125
.. automodule:: openeo.rest.datacube
2226
:members: DataCube
27+
:inherited-members:
28+
29+
30+
openeo.rest.vectorcube
31+
------------------------
32+
33+
.. automodule:: openeo.rest.vectorcube
34+
:members: VectorCube
35+
:inherited-members:
36+
2337

38+
openeo.rest.mlmodel
39+
---------------------
2440

25-
.. _datacube-api:
41+
.. automodule:: openeo.rest.mlmodel
42+
:members: MlModel
43+
:inherited-members:
2644

27-
openeo.api
28-
-----------
45+
46+
openeo.api.process
47+
--------------------
2948

3049
.. automodule:: openeo.api.process
3150
:members: Parameter
3251

52+
53+
openeo.api.logs
54+
-----------------
55+
3356
.. automodule:: openeo.api.logs
3457
:members: LogEntry
3558

@@ -42,7 +65,7 @@ openeo.rest.connection
4265

4366

4467
openeo.rest.job
45-
----------------------
68+
------------------
4669

4770
.. automodule:: openeo.rest.job
4871
:members: RESTJob, JobResults, ResultAsset

openeo/rest/mlmodel.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414

1515
class MlModel(_ProcessGraphAbstraction):
1616
"""
17-
A machine learning model accompanied with STAC metadata, including the ml-model extension.
17+
A machine learning model.
18+
19+
It is the result of a training procedure, e.g. output of a ``fit_...`` process,
20+
and can be used for prediction (classification or regression) with the corresponding ``predict_...`` process.
1821
"""
1922
def __init__(self, graph: PGNode, connection: 'Connection'):
2023
super().__init__(pgnode=graph, connection=connection)

0 commit comments

Comments
 (0)