minor changes on docs

feature/update-docs
Taiga Noumi 2020-02-27 08:21:47 +09:00
parent 4ff5642e4b
commit 9456137e94
3 changed files with 12 additions and 12 deletions

View File

@ -90,9 +90,9 @@ def averaging_opt(test_predictions: List[np.ndarray],
eval_func:
Evaluation metric used for calculating result score. Used only if ``oof_predictions`` and ``y`` are given.
higher_is_better:
Determine the direction of optimize ``eval_func``.
The direction of optimization of ``eval_func``.
weight_bounds:
Specify lower/upper bounds of each weight.
Bounds on weights for optimization.
rank_averaging:
If ``True``, predictions will be converted to rank before averaging.
Returns:

View File

@ -90,12 +90,12 @@ class Experiment(object):
Note that all output files are located both ``logging_directory`` and
mlflow's directory (``mlruns`` by default).
if_exists:
How to behave if the logging directory already exists.
How to behave if the logging directory already exists. Should be one of:
- error: Raise a ValueError.
- replace: Delete logging directory before logging.
- append: Append to exisitng experiment.
- rename: Rename current directory by adding "_1", "_2"... prefix
- 'error': Raises a ValueError.
- 'replace': Deletes logging directory before logging.
- 'append': Appends to exisitng experiment.
- 'rename': Renames current directory by adding "_1", "_2"... prefix
Example:
>>> import numpy as np
>>> import pandas as pd

View File

@ -113,12 +113,12 @@ def run_experiment(model_params: Dict[str, Any],
logging_directory:
Path to directory where output of experiment is stored.
if_exists:
How to behave if the logging directory already exists.
How to behave if the logging directory already exists. Should be one of:
- error: Raise a ValueError.
- replace: Delete logging directory before logging.
- append: Append to exisitng experiment.
- rename: Rename current directory by adding "_1", "_2"... prefix
- 'error': Raises a ValueError.
- 'replace': Deletes logging directory before logging.
- 'append': Appends to exisitng experiment.
- 'rename': Renames current directory by adding "_1", "_2"... prefix
fit_params:
Parameters passed to the fit method of the estimator. If dict is passed, the same parameter except
eval_set passed for each fold. If callable is passed,