Update documentation

openlayer-ai · Apr 30, 2024 · 14ba956 · 14ba956
1 parent ba97c30
commit 14ba956
Show file tree

Hide file tree

Showing 103 changed files with 21,754 additions and 1,132 deletions.
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+reference.openlayer.com
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,20 +1,34 @@
-.. No Errors Test Project documentation master file, created by
-   sphinx-quickstart on Fri Aug 30 17:07:56 2019.
+.. Openlayer Python API reference documentation master file, created by
+   sphinx-quickstart on Tue Apr 19 16:10:13 2022.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to No Errors Test Project's documentation!
-==================================================
+.. module:: openlayer
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Hello World!
+*********************************
+Openlayer Python Client reference
+*********************************
+
+**Date**: |today| **Version**: |version|
+
+Welcome to the API documentation for `Openlayer <https://openlayer.com>`__!
+
+These docs cover our official Python library, which you may use to interact with the Openlayer platform.
+
+Installation
+============
 
+The :mod:`openlayer` library is available on PyPI and conda-forge, and can be installed with:
 
+.. code:: console
 
-Indices and tables
-==================
+   $ pip install openlayer
+
+.. code:: console
+
+   $ conda install openlayer --channel conda-forge
+
+.. toctree::
+   :hidden:
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   reference/index
diff --git a/_sources/reference/api/openlayer.InferencePipeline.publish_batch_data.rst.txt b/_sources/reference/api/openlayer.InferencePipeline.publish_batch_data.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.publish\_batch\_data
+================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.publish_batch_data
diff --git a/_sources/reference/api/openlayer.InferencePipeline.publish_ground_truths.rst.txt b/_sources/reference/api/openlayer.InferencePipeline.publish_ground_truths.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.publish\_ground\_truths
+===================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.publish_ground_truths
diff --git a/_sources/reference/api/openlayer.InferencePipeline.stream_data.rst.txt b/_sources/reference/api/openlayer.InferencePipeline.stream_data.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.stream\_data
+========================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.stream_data
diff --git a/_sources/reference/api/openlayer.InferencePipeline.update_data.rst.txt b/_sources/reference/api/openlayer.InferencePipeline.update_data.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.update\_data
+========================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.update_data
diff --git a/...es/reference/api/openlayer.InferencePipeline.upload_reference_dataframe.rst.txt b/...es/reference/api/openlayer.InferencePipeline.upload_reference_dataframe.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.upload\_reference\_dataframe
+========================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.upload_reference_dataframe
diff --git a/...rces/reference/api/openlayer.InferencePipeline.upload_reference_dataset.rst.txt b/...rces/reference/api/openlayer.InferencePipeline.upload_reference_dataset.rst.txt
@@ -0,0 +1,6 @@
+openlayer.InferencePipeline.upload\_reference\_dataset
+======================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: InferencePipeline.upload_reference_dataset
diff --git a/_sources/reference/api/openlayer.OpenlayerClient.create_or_load_project.rst.txt b/_sources/reference/api/openlayer.OpenlayerClient.create_or_load_project.rst.txt
@@ -0,0 +1,6 @@
+openlayer.OpenlayerClient.create\_or\_load\_project
+===================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: OpenlayerClient.create_or_load_project
diff --git a/_sources/reference/api/openlayer.OpenlayerClient.create_project.rst.txt b/_sources/reference/api/openlayer.OpenlayerClient.create_project.rst.txt
@@ -0,0 +1,6 @@
+openlayer.OpenlayerClient.create\_project
+=========================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: OpenlayerClient.create_project
diff --git a/_sources/reference/api/openlayer.OpenlayerClient.load_project.rst.txt b/_sources/reference/api/openlayer.OpenlayerClient.load_project.rst.txt
@@ -0,0 +1,6 @@
+openlayer.OpenlayerClient.load\_project
+=======================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: OpenlayerClient.load_project
diff --git a/_sources/reference/api/openlayer.OpenlayerClient.load_project_version.rst.txt b/_sources/reference/api/openlayer.OpenlayerClient.load_project_version.rst.txt
@@ -0,0 +1,6 @@
+openlayer.OpenlayerClient.load\_project\_version
+================================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: OpenlayerClient.load_project_version
diff --git a/_sources/reference/api/openlayer.OpenlayerClient.rst.txt b/_sources/reference/api/openlayer.OpenlayerClient.rst.txt
@@ -0,0 +1,6 @@
+openlayer.OpenlayerClient
+=========================
+
+.. currentmodule:: openlayer
+
+.. autoclass:: OpenlayerClient
diff --git a/_sources/reference/api/openlayer.Project.add_dataframe.rst.txt b/_sources/reference/api/openlayer.Project.add_dataframe.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.add\_dataframe
+================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.add_dataframe
diff --git a/_sources/reference/api/openlayer.Project.add_dataset.rst.txt b/_sources/reference/api/openlayer.Project.add_dataset.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.add\_dataset
+==============================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.add_dataset
diff --git a/_sources/reference/api/openlayer.Project.add_model.rst.txt b/_sources/reference/api/openlayer.Project.add_model.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.add\_model
+============================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.add_model
diff --git a/_sources/reference/api/openlayer.Project.commit.rst.txt b/_sources/reference/api/openlayer.Project.commit.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.commit
+========================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.commit
diff --git a/_sources/reference/api/openlayer.Project.create_inference_pipeline.rst.txt b/_sources/reference/api/openlayer.Project.create_inference_pipeline.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.create\_inference\_pipeline
+=============================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.create_inference_pipeline
diff --git a/_sources/reference/api/openlayer.Project.export.rst.txt b/_sources/reference/api/openlayer.Project.export.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.export
+========================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.export
diff --git a/_sources/reference/api/openlayer.Project.load_inference_pipeline.rst.txt b/_sources/reference/api/openlayer.Project.load_inference_pipeline.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.load\_inference\_pipeline
+===========================================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.load_inference_pipeline
diff --git a/_sources/reference/api/openlayer.Project.push.rst.txt b/_sources/reference/api/openlayer.Project.push.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.push
+======================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.push
diff --git a/_sources/reference/api/openlayer.Project.restore.rst.txt b/_sources/reference/api/openlayer.Project.restore.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.restore
+=========================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.restore
diff --git a/_sources/reference/api/openlayer.Project.status.rst.txt b/_sources/reference/api/openlayer.Project.status.rst.txt
@@ -0,0 +1,6 @@
+openlayer.Project.status
+========================
+
+.. currentmodule:: openlayer
+
+.. automethod:: Project.status
diff --git a/_sources/reference/api/openlayer.ProjectVersion.rst.txt b/_sources/reference/api/openlayer.ProjectVersion.rst.txt
@@ -0,0 +1,6 @@
+openlayer.ProjectVersion
+========================
+
+.. currentmodule:: openlayer
+
+.. autoclass:: ProjectVersion
diff --git a/_sources/reference/api/openlayer.llm_monitors.AzureOpenAIMonitor.rst.txt b/_sources/reference/api/openlayer.llm_monitors.AzureOpenAIMonitor.rst.txt
@@ -0,0 +1,6 @@
+openlayer.llm\_monitors.AzureOpenAIMonitor
+==========================================
+
+.. currentmodule:: openlayer.llm_monitors
+
+.. autoclass:: AzureOpenAIMonitor
diff --git a/_sources/reference/api/openlayer.llm_monitors.OpenAIMonitor.rst.txt b/_sources/reference/api/openlayer.llm_monitors.OpenAIMonitor.rst.txt
@@ -0,0 +1,6 @@
+openlayer.llm\_monitors.OpenAIMonitor
+=====================================
+
+.. currentmodule:: openlayer.llm_monitors
+
+.. autoclass:: OpenAIMonitor
diff --git a/_sources/reference/api/openlayer.tasks.TaskType.rst.txt b/_sources/reference/api/openlayer.tasks.TaskType.rst.txt
@@ -0,0 +1,29 @@
+openlayer.tasks.TaskType
+========================
+
+.. currentmodule:: openlayer.tasks
+
+.. autoclass:: TaskType
+
+
+   .. automethod:: __init__
+
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~TaskType.LLMNER
+      ~TaskType.LLMQuestionAnswering
+      ~TaskType.LLMSummarization
+      ~TaskType.LLMTranslation
+      ~TaskType.LLM
+      ~TaskType.TabularClassification
+      ~TaskType.TabularRegression
+      ~TaskType.TextClassification
+
+
diff --git a/_sources/reference/api/openlayer.tracing.tracer.trace.rst.txt b/_sources/reference/api/openlayer.tracing.tracer.trace.rst.txt
@@ -0,0 +1,6 @@
+openlayer.tracing.tracer.trace
+==============================
+
+.. currentmodule:: openlayer.tracing.tracer
+
+.. autofunction:: trace
diff --git a/_sources/reference/authentication.rst.txt b/_sources/reference/authentication.rst.txt
@@ -0,0 +1,19 @@
+.. _api.authentication:
+
+==============
+Authentication
+==============
+.. currentmodule:: openlayer
+
+Openlayer uses API keys for client authentication. You can find your workspace API key on
+your `Account settings <https://docs.openlayer.com/docs/how-to-guides/find-your-api-key>`_.
+
+The authentication step happens when the ``OpenlayerClient`` is instantiated.
+
+Client
+------
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   OpenlayerClient
diff --git a/_sources/reference/development.rst.txt b/_sources/reference/development.rst.txt
@@ -0,0 +1,95 @@
+.. _api.development:
+
+===========
+Development
+===========
+.. currentmodule:: openlayer
+
+The development mode of a project helps you as you iterate on your models and datasets.
+You will use the methods described on this page to add models and datasets to your
+development project,
+
+To use these methods, you must have:
+
+1. Authenticated, using :obj:`openlayer.OpenlayerClient`
+
+2. Created a project, using :obj:`openlayer.OpenlayerClient.create_project`
+
+**Related guide**: `How to upload datasets and models for development <https://docs.openlayer.com/docs/how-to-guides/upload-datasets-and-models>`_.
+
+
+Staging area
+------------
+The upload of models and datasets to a project on Openlayer follows a similar flow
+to the one for uploading files to a version control system like Git.
+
+The ``add_*`` methods, add models and datasets to the local staging area.
+As you add resources to the staging area, you can check its status using the
+``status`` method.
+
+
+Finally, the resources on the staging area are committed and pushed to the Openlayer
+platform using the ``commit`` and ``push`` methods.
+
+
+Datasets
+--------
+Datasets stored as Pandas dataframes or csv files can be easily added to a project's
+staging area with the methods below.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   Project.add_dataset
+   Project.add_dataframe
+
+Models
+------
+Models are added to the staging area using the ``add_model`` method.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   Project.add_model
+
+Committing and pushing
+----------------------
+After adding resources to the staging area, you can commit and push them to Openlayer.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   Project.commit
+   Project.push
+
+Other methods to interact with the staging area
+-----------------------------------------------
+Additional methods used to interact with the staging area.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   Project.status
+   Project.restore
+   Project.export
+
+Checking a project version's goal statuses
+------------------------------------------
+To programatically check the status of a project version's goals, use the
+``ProjectVersion`` object, which can be obtained using the ``load_project_version`` method.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   ProjectVersion
+   OpenlayerClient.load_project_version
+
+
+
+
+