1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-13 15:56:57 +08:00

add warning and *

This commit is contained in:
Young
2021-06-11 10:40:56 +00:00
parent 5850490b24
commit 730f6258d6
2 changed files with 8 additions and 6 deletions

View File

@@ -215,9 +215,9 @@ class QlibRecorder:
------- -------
A dictionary (id -> recorder) of recorder information that being stored. A dictionary (id -> recorder) of recorder information that being stored.
""" """
return self.get_exp(experiment_id, experiment_name).list_recorders() return self.get_exp(experiment_id=experiment_id, experiment_name=experiment_name).list_recorders()
def get_exp(self, experiment_id=None, experiment_name=None, create: bool = True) -> Experiment: def get_exp(self, *, experiment_id=None, experiment_name=None, create: bool = True) -> Experiment:
""" """
Method for retrieving an experiment with given id or name. Once the `create` argument is set to Method for retrieving an experiment with given id or name. Once the `create` argument is set to
True, if no valid experiment is found, this method will create one for you. Otherwise, it will True, if no valid experiment is found, this method will create one for you. Otherwise, it will
@@ -262,7 +262,7 @@ class QlibRecorder:
# Case 2 # Case 2
with R.start('test'): with R.start('test'):
exp = R.get_exp('test1') exp = R.get_exp(experiment_name='test1')
# Case 3 # Case 3
exp = R.get_exp() -> a default experiment. exp = R.get_exp() -> a default experiment.
@@ -287,7 +287,9 @@ class QlibRecorder:
------- -------
An experiment instance with given id or name. An experiment instance with given id or name.
""" """
return self.exp_manager.get_exp(experiment_id, experiment_name, create, start=False) return self.exp_manager.get_exp(
experiment_id=experiment_id, experiment_name=experiment_name, create=create, start=False
)
def delete_exp(self, experiment_id=None, experiment_name=None): def delete_exp(self, experiment_id=None, experiment_name=None):
""" """

View File

@@ -109,7 +109,7 @@ class ExpManager:
""" """
raise NotImplementedError(f"Please implement the `search_records` method.") raise NotImplementedError(f"Please implement the `search_records` method.")
def get_exp(self, experiment_id=None, experiment_name=None, create: bool = True, start: bool = False): def get_exp(self, *, experiment_id=None, experiment_name=None, create: bool = True, start: bool = False):
""" """
Retrieve an experiment. This method includes getting an active experiment, and get_or_create a specific experiment. Retrieve an experiment. This method includes getting an active experiment, and get_or_create a specific experiment.
@@ -190,7 +190,7 @@ class ExpManager:
except ValueError: except ValueError:
if experiment_name is None: if experiment_name is None:
experiment_name = self._default_exp_name experiment_name = self._default_exp_name
logger.info(f"No valid experiment found. Create a new experiment with name {experiment_name}.") logger.warning(f"No valid experiment found. Create a new experiment with name {experiment_name}.")
return self.create_exp(experiment_name), True return self.create_exp(experiment_name), True
def _get_exp(self, experiment_id=None, experiment_name=None) -> Experiment: def _get_exp(self, experiment_id=None, experiment_name=None) -> Experiment: