fermilink.optimize.state module

fermilink.optimize.state.append_result(path, *, iteration, commit, status, primary_metric_name, primary_metric_value, description)

Parameters:

• path (Path)

• iteration (int)

• commit (str)

• status (str)

• primary_metric_name (str)

• primary_metric_value (float | int | str)

• description (str)

Return type:

None

fermilink.optimize.state.archive_worker_memory(source_path, run_dir)

Parameters:

• source_path (Path)

• run_dir (Path)

Return type:

Path | None

fermilink.optimize.state.autogen_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.clear_run_lock(path)

Parameters:

path (Path)

Return type:

None

fermilink.optimize.state.default_program_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.ensure_autogen_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.ensure_executable(path)

Parameters:

path (Path)

Return type:

None

fermilink.optimize.state.ensure_memory_file(path, *, package_id, benchmark_id, benchmark_rel, optimize_branch)

Parameters:

• path (Path)

• package_id (str)

• benchmark_id (str)

• benchmark_rel (str)

• optimize_branch (str)

Return type:

bool

fermilink.optimize.state.ensure_optimize_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.ensure_program_file(path, *, content)

Parameters:

• path (Path)

• content (str)

Return type:

bool

fermilink.optimize.state.ensure_results_file(path)

Parameters:

path (Path)

Return type:

bool

fermilink.optimize.state.goal_analysis_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_benchmark_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_copy_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_inputs_all_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_inputs_manifest_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_inputs_worker_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_manifest_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_run_script_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_runner_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_setup_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.goal_submit_launcher_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.inputs_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.load_json_file(path)

Parameters:

path (Path)

Return type:

dict[str, Any] | None

fermilink.optimize.state.load_run_lock(path)

Parameters:

path (Path)

Return type:

dict[str, Any] | None

fermilink.optimize.state.load_state(path)

Parameters:

path (Path)

Return type:

dict[str, Any] | None

fermilink.optimize.state.memory_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.optimize_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.pid_is_running(pid)

Parameters:

pid (int)

Return type:

bool

fermilink.optimize.state.quick_benchmark_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.quick_manifest_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.quick_run_script_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.quick_runner_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.quick_setup_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.quick_submit_launcher_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.recent_results_text(path, *, limit=8)

Parameters:

• path (Path)

• limit (int)

Return type:

str

fermilink.optimize.state.record_campaign_event(path, *, commit, primary_metric_name, primary_metric_value, status, description)

Parameters:

• path (Path)

• commit (str)

• primary_metric_name (str)

• primary_metric_value (float | int | str)

• status (str)

• description (str)

Return type:

None

fermilink.optimize.state.reset_worker_memory_file(path, *, package_id, benchmark_id, benchmark_rel, program_rel, controller_memory_rel, results_rel, worker_iteration)

Parameters:

• path (Path)

• package_id (str)

• benchmark_id (str)

• benchmark_rel (str)

• program_rel (str)

• controller_memory_rel (str)

• results_rel (str)

• worker_iteration (int)

Return type:

None

fermilink.optimize.state.results_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.run_lock_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.runs_root(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.safe_relative(path, root)

Parameters:

• path (Path)

• root (Path)

Return type:

str

fermilink.optimize.state.state_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.utc_now_z()

Return type:

str

fermilink.optimize.state.worker_benchmark_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.worker_memory_path(project_root)

Parameters:

project_root (Path)

Return type:

Path

fermilink.optimize.state.write_json_file(path, payload)

Parameters:

• path (Path)

• payload (dict[str, Any])

Return type:

None

fermilink.optimize.state.write_run_lock(path, payload)

Parameters:

• path (Path)

• payload (dict[str, Any])

Return type:

None

fermilink.optimize.state.write_state(path, payload)

Parameters:

• path (Path)

• payload (dict[str, Any])

Return type:

None