Skip to content

Fix ExperimentClient.list method parameters #203

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 23, 2020
Merged

Fix ExperimentClient.list method parameters #203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions gradient/api_sdk/clients/experiment_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,16 +706,20 @@ def stop(self, experiment_id, use_vpc=False):
repository = repositories.StopExperiment(api_key=self.api_key, logger=self.logger)
repository.stop(experiment_id, use_vpc=use_vpc)

def list(self, project_id=None, **kwargs):
def list(self, project_id=None, offset=None, limit=None, get_meta=False):
"""Get a list of experiments. Optionally filter by project ID

:param str|list|None project_id:
:param int offset:
:param int limit:
:param bool get_meta: get dict of metadata like number of total items, etc. Setting to True changes rtype

:return: experiments
:rtype: list[models.SingleNodeExperiment|models.MultiNodeExperiment]
:rtype: list[models.SingleNodeExperiment|models.MultiNodeExperiment]|tuple[list[models.SingleNodeExperiment|models.MultiNodeExperiment],dict]
"""

repository = repositories.ListExperiments(api_key=self.api_key, logger=self.logger)
experiments = repository.list(project_id=project_id, **kwargs)
experiments = repository.list(project_id=project_id, limit=limit, offset=offset, get_meta=get_meta)
return experiments

def get(self, experiment_id):
Expand Down