Skip to content

Commit e2cfc05

Browse files
actions-useractions-user
committed
Update documentation
1 parent ba97c30 commit e2cfc05

File tree

95 files changed

+19315
-1132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+19315
-1132
lines changed

‎CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
reference.openlayer.com

‎_sources/index.rst.txt

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
1-
.. No Errors Test Project documentation master file, created by
2-
sphinx-quickstart on Fri Aug 30 17:07:56 2019.
1+
.. Openlayer Python API reference documentation master file, created by
2+
sphinx-quickstart on Tue Apr 19 16:10:13 2022.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to No Errors Test Project's documentation!
7-
==================================================
6+
.. module:: openlayer
87

9-
.. toctree::
10-
:maxdepth: 2
11-
:caption: Hello World!
8+
*********************************
9+
Openlayer Python Client reference
10+
*********************************
11+
12+
**Date**: |today| **Version**: |version|
13+
14+
Welcome to the API documentation for `Openlayer <https://openlayer.com>`__!
15+
16+
These docs cover our official Python library, which you may use to interact with the Openlayer platform.
17+
18+
Installation
19+
============
1220

21+
The :mod:`openlayer` library is available on PyPI and conda-forge, and can be installed with:
1322

23+
.. code:: console
1424
15-
Indices and tables
16-
==================
25+
$ pip install openlayer
26+
27+
.. code:: console
28+
29+
$ conda install openlayer --channel conda-forge
30+
31+
.. toctree::
32+
:hidden:
1733

18-
* :ref:`genindex`
19-
* :ref:`modindex`
20-
* :ref:`search`
34+
reference/index

‎_sources/reference/api/openlayer.InferencePipeline.publish_batch_data.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.InferencePipeline.publish\_batch\_data
2+
================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: InferencePipeline.publish_batch_data

‎_sources/reference/api/openlayer.InferencePipeline.publish_ground_truths.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.InferencePipeline.publish\_ground\_truths
2+
===================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: InferencePipeline.publish_ground_truths

‎_sources/reference/api/openlayer.InferencePipeline.upload_reference_dataframe.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.InferencePipeline.upload\_reference\_dataframe
2+
========================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: InferencePipeline.upload_reference_dataframe

‎_sources/reference/api/openlayer.InferencePipeline.upload_reference_dataset.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.InferencePipeline.upload\_reference\_dataset
2+
======================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: InferencePipeline.upload_reference_dataset

‎_sources/reference/api/openlayer.OpenlayerClient.create_or_load_project.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.OpenlayerClient.create\_or\_load\_project
2+
===================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: OpenlayerClient.create_or_load_project

‎_sources/reference/api/openlayer.OpenlayerClient.create_project.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.OpenlayerClient.create\_project
2+
=========================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: OpenlayerClient.create_project

‎_sources/reference/api/openlayer.OpenlayerClient.load_project.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.OpenlayerClient.load\_project
2+
=======================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: OpenlayerClient.load_project

‎_sources/reference/api/openlayer.OpenlayerClient.load_project_version.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.OpenlayerClient.load\_project\_version
2+
================================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: OpenlayerClient.load_project_version

‎_sources/reference/api/openlayer.OpenlayerClient.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.OpenlayerClient
2+
=========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. autoclass:: OpenlayerClient

‎_sources/reference/api/openlayer.Project.add_dataframe.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.add\_dataframe
2+
================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.add_dataframe

‎_sources/reference/api/openlayer.Project.add_dataset.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.add\_dataset
2+
==============================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.add_dataset

‎_sources/reference/api/openlayer.Project.add_model.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.add\_model
2+
============================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.add_model

‎_sources/reference/api/openlayer.Project.commit.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.commit
2+
========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.commit

‎_sources/reference/api/openlayer.Project.create_inference_pipeline.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.create\_inference\_pipeline
2+
=============================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.create_inference_pipeline

‎_sources/reference/api/openlayer.Project.export.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.export
2+
========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.export

‎_sources/reference/api/openlayer.Project.load_inference_pipeline.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.load\_inference\_pipeline
2+
===========================================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.load_inference_pipeline

‎_sources/reference/api/openlayer.Project.push.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.push
2+
======================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.push

‎_sources/reference/api/openlayer.Project.restore.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.restore
2+
=========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.restore

‎_sources/reference/api/openlayer.Project.status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.Project.status
2+
========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. automethod:: Project.status

‎_sources/reference/api/openlayer.ProjectVersion.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.ProjectVersion
2+
========================
3+
4+
.. currentmodule:: openlayer
5+
6+
.. autoclass:: ProjectVersion

‎_sources/reference/api/openlayer.llm_monitors.OpenAIMonitor.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openlayer.llm\_monitors.OpenAIMonitor
2+
=====================================
3+
4+
.. currentmodule:: openlayer.llm_monitors
5+
6+
.. autoclass:: OpenAIMonitor

‎_sources/reference/api/openlayer.tasks.TaskType.rst.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
openlayer.tasks.TaskType
2+
========================
3+
4+
.. currentmodule:: openlayer.tasks
5+
6+
.. autoclass:: TaskType
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Attributes
17+
18+
.. autosummary::
19+
20+
~TaskType.LLMNER
21+
~TaskType.LLMQuestionAnswering
22+
~TaskType.LLMSummarization
23+
~TaskType.LLMTranslation
24+
~TaskType.LLM
25+
~TaskType.TabularClassification
26+
~TaskType.TabularRegression
27+
~TaskType.TextClassification
28+
29+

‎_sources/reference/authentication.rst.txt

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _api.authentication:
2+
3+
==============
4+
Authentication
5+
==============
6+
.. currentmodule:: openlayer
7+
8+
Openlayer uses API keys for client authentication. You can find your workspace API key on
9+
your `Account settings <https://docs.openlayer.com/docs/find-your-api-keys>`_.
10+
11+
The authentication step happens when the ``OpenlayerClient`` is instantiated.
12+
13+
Client
14+
------
15+
.. autosummary::
16+
:toctree: api/
17+
:template: class.rst
18+
19+
OpenlayerClient

‎_sources/reference/development.rst.txt

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
.. _api.development:
2+
3+
===========
4+
Development
5+
===========
6+
.. currentmodule:: openlayer
7+
8+
The development mode of a project helps you as you iterate on your models and datasets.
9+
You will use the methods described on this page to add models and datasets to your
10+
development project,
11+
12+
To use these methods, you must have:
13+
14+
1. Authenticated, using :obj:`openlayer.OpenlayerClient`
15+
16+
2. Created a project, using :obj:`openlayer.OpenlayerClient.create_project`
17+
18+
**Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/upload-datasets-and-models>`_.
19+
20+
21+
Staging area
22+
------------
23+
The upload of models and datasets to a project on Openlayer follows a similar flow
24+
to the one for uploading files to a version control system like Git.
25+
26+
The ``add_*`` methods, add models and datasets to the local staging area.
27+
As you add resources to the staging area, you can check its status using the
28+
``status`` method.
29+
30+
31+
Finally, the resources on the staging area are committed and pushed to the Openlayer
32+
platform using the ``commit`` and ``push`` methods.
33+
34+
35+
Datasets
36+
--------
37+
Datasets stored as Pandas dataframes or csv files can be easily added to a project's
38+
staging area with the methods below.
39+
40+
.. autosummary::
41+
:toctree: api/
42+
:template: class.rst
43+
44+
Project.add_dataset
45+
Project.add_dataframe
46+
47+
Models
48+
------
49+
Models are added to the staging area using the ``add_model`` method.
50+
51+
.. autosummary::
52+
:toctree: api/
53+
:template: class.rst
54+
55+
Project.add_model
56+
57+
Committing and pushing
58+
----------------------
59+
After adding resources to the staging area, you can commit and push them to Openlayer.
60+
61+
.. autosummary::
62+
:toctree: api/
63+
:template: class.rst
64+
65+
Project.commit
66+
Project.push
67+
68+
Other methods to interact with the staging area
69+
-----------------------------------------------
70+
Additional methods used to interact with the staging area.
71+
72+
.. autosummary::
73+
:toctree: api/
74+
:template: class.rst
75+
76+
Project.status
77+
Project.restore
78+
Project.export
79+
80+
Checking a project version's goal statuses
81+
------------------------------------------
82+
To programatically check the status of a project version's goals, use the
83+
``ProjectVersion`` object, which can be obtained using the ``load_project_version`` method.
84+
85+
.. autosummary::
86+
:toctree: api/
87+
:template: class.rst
88+
89+
ProjectVersion
90+
OpenlayerClient.load_project_version
91+
92+
93+
94+
95+

0 commit comments

Comments
 (0)