diff --git a/aiaccel/hpo/apps/optimize.py b/aiaccel/hpo/apps/optimize.py index 61c834da..0eca09bc 100644 --- a/aiaccel/hpo/apps/optimize.py +++ b/aiaccel/hpo/apps/optimize.py @@ -94,10 +94,9 @@ def main() -> None: executor: _target_: aiaccel.hpo.job_executors.LocalJobExecutor n_max_jobs: 4 - - result: - _target_: aiaccel.hpo.job_output_loaders.JsonJobOutputLoader - filename_template: "{job.cwd}/{job.job_name}_result.json" + loader: + _target_: aiaccel.hpo.job_output_loaders.JsonJobOutputLoader + filename_template: "{job.cwd}/{job.job_name}_result.json" params: _convert_: partial diff --git a/aiaccel/hpo/job_output_loaders/json_loader.py b/aiaccel/hpo/job_output_loaders/json_loader.py index 72928d9c..e92cb37c 100644 --- a/aiaccel/hpo/job_output_loaders/json_loader.py +++ b/aiaccel/hpo/job_output_loaders/json_loader.py @@ -14,7 +14,7 @@ class JsonJobOutputLoader(BaseJobOutputLoader): __init__(filename_template: str) -> None: Initializes the JsonJobOutputLoader with a filename template. - load(job: BaseJobExecutor) -> int | float | str: + load(job: BaseJob) -> int | float | str: Loads the result from a JSON file based on the job information. """ diff --git a/aiaccel/hpo/job_output_loaders/pickle_loader.py b/aiaccel/hpo/job_output_loaders/pickle_loader.py index 0ace21b2..01c11a9f 100644 --- a/aiaccel/hpo/job_output_loaders/pickle_loader.py +++ b/aiaccel/hpo/job_output_loaders/pickle_loader.py @@ -14,7 +14,7 @@ class PickleJobOutputLoader(BaseJobOutputLoader): __init__(filename_template: str) -> None: Initializes the PickleJobOutputLoader with a filename template. - load(job: BaseJobExecutor) -> int | float | str: + load(job: BaseJob) -> int | float | str: Loads the result from a pickle file corresponding to the given job. """ diff --git a/aiaccel/hpo/job_output_loaders/stdout_loader.py b/aiaccel/hpo/job_output_loaders/stdout_loader.py index daca9ba8..dd6bad5a 100644 --- a/aiaccel/hpo/job_output_loaders/stdout_loader.py +++ b/aiaccel/hpo/job_output_loaders/stdout_loader.py @@ -11,7 +11,7 @@ class StdoutJobOutputLoader(BaseJobOutputLoader): filename_template (str): A template for the filename where the results are stored. Methods: - load(job: BaseJobExecutor) -> int | float | str: + load(job: BaseJob) -> int | float | str: Loads the result from the file corresponding to the given job. The result is expected to be on the last non-empty line of the file. Returns the result as an integer, float, or string, depending on the content. diff --git a/docs/source/user_guide/hpo.rst b/docs/source/user_guide/hpo.rst index cab96eeb..54a9f666 100644 --- a/docs/source/user_guide/hpo.rst +++ b/docs/source/user_guide/hpo.rst @@ -72,10 +72,9 @@ Basic configuration example: executor: _target_: aiaccel.hpo.job_executors.LocalJobExecutor n_max_jobs: 4 - - result: - _target_: aiaccel.hpo.job_output_loaders.JsonResult - filename_template: "{job.cwd}/{job.job_name}_result.json" + loader: + _target_: aiaccel.hpo.job_output_loaders.JsonResult + filename_template: "{job.cwd}/{job.job_name}_result.json" params: x1: [0, 1] @@ -124,9 +123,11 @@ JSON Format (Default): .. code-block:: yaml - result: - _target_: aiaccel.hpo.job_output_loaders.JsonResult - filename_template: "{job.cwd}/{job.job_name}_result.json" + executor: + ... + loader: + _target_: aiaccel.hpo.job_output_loaders.JsonResult + filename_template: "{job.cwd}/{job.job_name}_result.json" Example objective function for JSON: @@ -147,9 +148,11 @@ Pickle Format: .. code-block:: yaml - result: - _target_: aiaccel.hpo.job_output_loaders.PickleResult - filename_template: "{job.cwd}/{job.job_name}_result.pkl" + executor: + ... + loader: + _target_: aiaccel.hpo.job_output_loaders.PickleResult + filename_template: "{job.cwd}/{job.job_name}_result.pkl" Example objective function for Pickle: @@ -170,9 +173,11 @@ Stdout Format: .. code-block:: yaml - result: - _target_: aiaccel.hpo.job_output_loaders.StdoutResult - filename_template: "{job.cwd}/{job.job_name}_result.txt" + executor: + ... + loader: + _target_: aiaccel.hpo.job_output_loaders.StdoutResult + filename_template: "{job.cwd}/{job.job_name}_result.txt" Example objective function for Stdout: