Add PERIAN agent docs (#2816)

Signed-off-by: Omar Tarabai <omar@tarabai.com>
flyteorg · Oct 15, 2024 · f164191 · f164191
1 parent 5fe2ee3
commit f164191
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/docs/source/plugins/index.rst b/docs/source/plugins/index.rst
@@ -19,6 +19,7 @@ Plugin API reference
 * :ref:`Modin <modin>` - Modin API reference
 * :ref:`Pandera <pandera>` - Pandera API reference
 * :ref:`Papermill <papermill>` - Papermill API reference
+* :ref:`PERIAN <perian>` - PERIAN Job Platform API reference
 * :ref:`Snowflake <snowflake>` - Snowflake API reference
 * :ref:`Spark <spark>` - Spark API reference
 * :ref:`SQLAlchemy <sqlalchemy>` - SQLAlchemy API reference
@@ -55,6 +56,7 @@ Plugin API reference
    Modin <modin>
    Pandera <pandera>
    Papermill <papermill>
+   PERIAN <perian>
    Snowflake <snowflake>
    Spark <spark>
    SQLAlchemy <sqlalchemy>

diff --git a/docs/source/plugins/perian.rst b/docs/source/plugins/perian.rst
@@ -0,0 +1,12 @@
+.. _perian:
+
+###################################################
+PERIAN Job Platform API reference
+###################################################
+
+.. tags:: Cloud, GPU, Integration, Advanced
+
+.. automodule:: flytekitplugins.perian_job
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/plugins/flytekit-perian/flytekitplugins/perian_job/__init__.py b/plugins/flytekit-perian/flytekitplugins/perian_job/__init__.py
@@ -1,2 +1,14 @@
+"""
+.. currentmodule:: flytekitplugins.perian_job
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   PerianAgent
+   PerianConfig
+   PerianTask
+"""
+
 from .agent import PerianAgent
 from .task import PerianConfig, PerianTask
diff --git a/plugins/flytekit-perian/flytekitplugins/perian_job/agent.py b/plugins/flytekit-perian/flytekitplugins/perian_job/agent.py
@@ -35,13 +35,13 @@
 
 @dataclass
 class PerianMetadata(ResourceMeta):
-    """Metadata for Perian jobs"""
+    """Metadata for PERIAN jobs"""
 
     job_id: str
 
 
 class PerianAgent(AsyncAgentBase):
-    """Flyte Agent for executing tasks on Perian"""
+    """Flyte Agent for executing tasks on PERIAN Job Platform"""
 
     name = "Perian Agent"
 

diff --git a/plugins/flytekit-perian/flytekitplugins/perian_job/task.py b/plugins/flytekit-perian/flytekitplugins/perian_job/task.py
@@ -32,7 +32,7 @@ class PerianConfig:
 
 
 class PerianTask(AsyncAgentExecutorMixin, PythonFunctionTask):
-    """A special task type for running tasks on Perian Job Platform (perian.io)"""
+    """A special task type for running tasks on PERIAN Job Platform (perian.io)"""
 
     _TASK_TYPE = "perian_task"