Add doc

Author: Delaunay

docs/src/code/client.rst

@@ -9,6 +9,7 @@ Client helper functions
    client/cli
    client/experiment
    client/manual
+   client/extensions
 
 .. automodule:: orion.client
    :members:

docs/src/code/client/experiment.rst

@@ -1,5 +1,5 @@
 Experiment client
 =================
 
-.. automodule:: orion.client.experiment
+.. automodule:: orion.client.experiment.OrionExtension
    :members:

docs/src/code/client/extensions.rst

@@ -0,0 +1,7 @@
+Extensions
+==========
+
+.. automodule:: orion.ext.extensions.OrionExtension
+   :members:
+
+

setup.py

@@ -21,6 +21,7 @@
     "orion.client",
     "orion.core",
     "orion.executor",
+    "orion.ext",
     "orion.plotting",
     "orion.serving",
     "orion.storage",

src/orion/client/experiment.py

@@ -73,6 +73,10 @@ class ExperimentClient:
     producer: `orion.core.worker.producer.Producer`
         Producer object used to produce new trials.
 
+    Notes
+    -----
+
+    Users can write generic extensions to ExperimentClient through `orion.client.experiment.OrionExtension`.
     """
 
     def __init__(self, experiment, producer, executor=None, heartbeat=None):
@@ -322,6 +326,16 @@ def fetch_noncompleted_trials(self, with_evc_tree=False):
     ###
     # Actions
     ###
+    def register_extension(self, ext):
+        """Register a third party extension
+
+        Parameters
+        ----------
+        ext: OrionExtension
+            object that implements the OrionExtension interface
+
+        """
+        return self.extensions.register(ext)
 
     # pylint: disable=unused-argument
     def insert(self, params, results=None, reserve=False):