Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add python api example and update doc #3396

Merged
merged 13 commits into from
Feb 25, 2021
Merged

Conversation

J-shang
Copy link
Contributor

@J-shang J-shang commented Feb 23, 2021

A jupyter notebook example about Experiment.start() and Experiment.connect().

@J-shang J-shang mentioned this pull request Feb 24, 2021
94 tasks
@@ -13,6 +13,7 @@ scikit-learn>=0.23.2
websockets
filelock
prettytable
ipython
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this file used for?


.. code:: ipython3

experiment.connect(8080)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which one is correct? Experiment.connect()?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now, experiment.connect().

Return experiment metadata with specified exp_id as a dict.

Returns
----------
Copy link
Contributor

@QuanluZhang QuanluZhang Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returns
-------

@@ -204,7 +204,7 @@ def run(self, port: int = 8080, debug: bool = False) -> bool:
finally:
self.stop()

def connect_experiment(self, port: int):
def connect(self, port: int):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest to decorate it with @classmethod or @staticmethod

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants