Skip to content

Commit c366d02

Browse files
committed
Add doc
1 parent 2339ac3 commit c366d02

5 files changed

Lines changed: 25 additions & 1 deletion

File tree

docs/src/code/client.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Client helper functions
99
client/cli
1010
client/experiment
1111
client/manual
12+
client/extensions
1213

1314
.. automodule:: orion.client
1415
:members:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Experiment client
22
=================
33

4-
.. automodule:: orion.client.experiment
4+
.. automodule:: orion.client.experiment.OrionExtension
55
:members:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Extensions
2+
==========
3+
4+
.. automodule:: orion.ext.extensions.OrionExtension
5+
:members:
6+
7+

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"orion.client",
2222
"orion.core",
2323
"orion.executor",
24+
"orion.ext",
2425
"orion.plotting",
2526
"orion.serving",
2627
"orion.storage",

src/orion/client/experiment.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ class ExperimentClient:
7373
producer: `orion.core.worker.producer.Producer`
7474
Producer object used to produce new trials.
7575
76+
Notes
77+
-----
78+
79+
Users can write generic extensions to ExperimentClient through
80+
`orion.client.experiment.OrionExtension`.
7681
"""
7782

7883
def __init__(self, experiment, producer, executor=None, heartbeat=None):
@@ -322,6 +327,16 @@ def fetch_noncompleted_trials(self, with_evc_tree=False):
322327
###
323328
# Actions
324329
###
330+
def register_extension(self, ext):
331+
"""Register a third party extension
332+
333+
Parameters
334+
----------
335+
ext: OrionExtension
336+
object that implements the OrionExtension interface
337+
338+
"""
339+
return self.extensions.register(ext)
325340

326341
# pylint: disable=unused-argument
327342
def insert(self, params, results=None, reserve=False):

0 commit comments

Comments
 (0)