Skip to content

Commit 31ed72a

Browse files
Completes OPEN-3399 Update Python API reference examples given the new commit-style
1 parent 2e9eb08 commit 31ed72a

File tree

6 files changed

+309
-92
lines changed

6 files changed

+309
-92
lines changed

docs/source/reference/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This page gives an overview of all public openlayer objects, functions and metho
1010
:maxdepth: 2
1111

1212
upload
13+
validate
1314

1415
.. meta::
1516
:description lang=en:

docs/source/reference/upload.rst

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ Project creation and loading
2121

2222
OpenlayerClient.create_project
2323
OpenlayerClient.load_project
24+
OpenlayerClient.create_or_load_project
2425

25-
Upload functions
26-
----------------
26+
Add models and datasets
27+
-----------------------
2728
.. autosummary::
2829
:toctree: api/
2930
:template: class.rst
@@ -32,21 +33,22 @@ Upload functions
3233
OpenlayerClient.add_dataset
3334
OpenlayerClient.add_dataframe
3435

35-
Model / Task types
36-
------------------
36+
Version control flow
37+
--------------------
3738
.. autosummary::
3839
:toctree: api/
40+
:template: class.rst
41+
42+
OpenlayerClient.commit
43+
OpenlayerClient.push
44+
OpenlayerClient.status
45+
OpenlayerClient.restore
3946

40-
ModelType
41-
TaskType
42-
43-
Objects
44-
-------
47+
Dataset / Task types
48+
--------------------
4549
.. autosummary::
4650
:toctree: api/
47-
:template: class.rst
48-
49-
Model
50-
Dataset
51-
Model.to_dict
52-
Dataset.to_dict
51+
52+
DatasetType
53+
TaskType
54+

docs/source/reference/validate.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _api.validate:
2+
3+
==========================
4+
Validate models / datasets
5+
==========================
6+
.. currentmodule:: openlayer
7+
8+
These classes and its methods can be used to ensure that the models
9+
and datasets are in the format expected by the Openlayer platform.
10+
Once all the validations are passing, the user can use the methods to upload
11+
these resources to the platform.
12+
13+
Models
14+
------
15+
.. autosummary::
16+
:toctree: api/
17+
:template: class.rst
18+
19+
validators.ModelValidator
20+
21+
Datasets
22+
--------
23+
.. autosummary::
24+
:toctree: api/
25+
:template: class.rst
26+
27+
validators.DatasetValidator
28+

0 commit comments

Comments
 (0)