FlexLock
Getting Started
Philosophy & Design
Quickstart Guide
User Guide
FlexLock Usage Guide
Agentic Workflows
Debugging with FlexLock
HPC Integration
API Reference
Python API Reference
CLI Reference
OmegaConf Resolvers
MLflow Integration Guide
Reference
API Reference
Additional
FlexLock Documentation
Changelog
FlexLock
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
apply_overrides() (in module flexlock.utils)
B
Backend (class in flexlock.backends.base)
C
CACHED (flexlock.api.Status attribute)
cancel() (flexlock.backends.pbs.PBSJob method)
(flexlock.backends.slurm.SlurmJob method)
cancel_job() (flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
ChainedResult (class in flexlock.api)
check() (flexlock.api.Project method)
(flexlock.Project method)
check_status() (flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
claim_next_task() (in module flexlock.taskdb)
claim_next_tasks() (in module flexlock.taskdb)
clear_error() (flexlock.run_record.RunRecord method)
code_drift() (in module flexlock.git_utils)
collect_results() (flexlock.api.Project static method)
(flexlock.Project static method)
collect_target_include_patterns() (in module flexlock.utils)
collect_task_repos() (in module flexlock.utils)
compare_config() (flexlock.diff.RunDiff method)
compare_data() (flexlock.diff.RunDiff method)
compare_env() (flexlock.diff.RunDiff method)
compare_git() (flexlock.diff.RunDiff method)
compare_snapshots() (in module flexlock.diff_cli)
complete_path (flexlock.run_record.RunRecord property)
create_shadow_snapshot() (in module flexlock.git_utils)
create_shadow_tree() (in module flexlock.git_utils)
D
debug_on_fail() (in module flexlock)
(in module flexlock.debug)
defaults_module() (in module flexlock.utils)
defer_unpinned_runs() (in module flexlock.resolvers)
deferred_stubbed() (in module flexlock.resolvers)
dirhash() (in module flexlock.data_hash)
downstream (flexlock.api.ChainedResult attribute)
dump_to_yaml() (in module flexlock.taskdb)
E
enqueue_to_file() (in module flexlock)
(in module flexlock.utils)
environment() (flexlock.backends.base.Backend method)
(flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
error_path (flexlock.run_record.RunRecord property)
ExecutionResult (class in flexlock.api)
exists() (flexlock.api.Project method)
(flexlock.Project method)
expand_swaps() (in module flexlock.utils)
export_all_tasks() (in module flexlock.export)
export_task() (in module flexlock.export)
extract_tracking_info() (in module flexlock.utils)
F
FAILED (flexlock.api.Status attribute)
finish_task() (in module flexlock.taskdb)
finish_tasks() (in module flexlock.taskdb)
flexcli() (in module flexlock)
flexlock
module
flexlock.api
module
flexlock.backends.base
module
flexlock.backends.pbs
module
flexlock.backends.slurm
module
flexlock.context
module
flexlock.data_hash
module
flexlock.debug
module
flexlock.diff
module
flexlock.diff_cli
module
flexlock.export
module
flexlock.git_utils
module
flexlock.load_stage
module
flexlock.mlflow
module
flexlock.parallel
module
flexlock.resolvers
module
flexlock.run_cli
module
flexlock.run_record
module
flexlock.runner
module
flexlock.status_cli
module
flexlock.taskdb
module
flexlock.utils
module
flexlock.worker
module
FlexLockBackendError
FlexLockCacheError
FlexLockConfigError
FlexLockError
FlexLockExecutionError
FlexLockRunner (class in flexlock)
(class in flexlock.runner)
FlexLockSnapshotError
FlexLockValidationError
frozen_resolvers() (in module flexlock.resolvers)
G
get() (flexlock.api.ExecutionResult method)
(flexlock.api.Project method)
(flexlock.Project method)
get_all_tasks() (in module flexlock.taskdb)
get_failed_tasks() (in module flexlock.taskdb)
get_git_commit() (in module flexlock.git_utils)
get_git_tree_hash() (in module flexlock)
(in module flexlock.git_utils)
get_result() (flexlock.api.Project method)
(flexlock.Project method)
get_status_counts() (in module flexlock.taskdb)
get_status_counts_by_tag() (in module flexlock.taskdb)
get_task_snapshot() (in module flexlock.taskdb)
get_task_status() (in module flexlock.taskdb)
global_rank (flexlock.backends.base.JobEnvironment property)
H
hash_data() (in module flexlock)
(in module flexlock.data_hash)
I
instantiate() (in module flexlock.utils)
INTERRUPTED (flexlock.api.Status attribute)
is_complete (flexlock.run_record.RunRecord property)
is_complete_task() (flexlock.run_record.RunRecord method)
is_match() (flexlock.diff.RunDiff method)
is_placeholder_lock() (in module flexlock.run_record)
is_success (flexlock.api.ExecutionResult property)
is_terminal() (flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
J
Job (class in flexlock.backends.base)
job_id (flexlock.backends.base.Job property)
(flexlock.backends.pbs.PBSJob property)
(flexlock.backends.slurm.SlurmJob property)
JobEnvironment (class in flexlock.backends.base)
L
latest_resolver() (in module flexlock.resolvers)
list_task_snapshots() (in module flexlock.taskdb)
load() (flexlock.run_record.RunRecord method)
load_config() (flexlock.FlexLockRunner method)
(flexlock.runner.FlexLockRunner method)
load_error() (flexlock.run_record.RunRecord method)
load_lock_data() (in module flexlock.run_record)
load_python_defaults() (in module flexlock)
(in module flexlock.utils)
load_results() (flexlock.run_record.RunRecord method)
load_snapshot_from_db() (in module flexlock.diff_cli)
load_snapshot_from_dir() (in module flexlock.diff_cli)
load_stage_from_path() (in module flexlock.load_stage)
load_sweep() (in module flexlock)
(in module flexlock.utils)
load_tasks() (in module flexlock.parallel)
lock_path (flexlock.run_record.RunRecord property)
log_to_file() (in module flexlock)
(in module flexlock.utils)
M
main() (in module flexlock.diff_cli)
(in module flexlock.export)
(in module flexlock.run_cli)
(in module flexlock.status_cli)
mark_complete() (flexlock.run_record.RunRecord method)
mark_orphans_interrupted() (in module flexlock.taskdb)
materialize_lock() (in module flexlock.run_record)
merge_master_into_task_snapshot() (in module flexlock.run_record)
merge_task_into_cfg() (in module flexlock.utils)
metrics (flexlock.api.ExecutionResult property)
mlflow_context() (in module flexlock)
(in module flexlock.mlflow)
module
flexlock
flexlock.api
flexlock.backends.base
flexlock.backends.pbs
flexlock.backends.slurm
flexlock.context
flexlock.data_hash
flexlock.debug
flexlock.diff
flexlock.diff_cli
flexlock.export
flexlock.git_utils
flexlock.load_stage
flexlock.mlflow
flexlock.parallel
flexlock.resolvers
flexlock.run_cli
flexlock.run_record
flexlock.runner
flexlock.status_cli
flexlock.taskdb
flexlock.utils
flexlock.worker
N
now_resolver() (in module flexlock.resolvers)
O
override_module (flexlock.api.Project attribute)
(flexlock.Project attribute)
P
ParallelExecutor (class in flexlock.parallel)
parse_sweep_string() (in module flexlock)
(in module flexlock.utils)
PBSBackend (class in flexlock.backends.pbs)
PBSJob (class in flexlock.backends.pbs)
pending_count() (in module flexlock.taskdb)
print_all_tasks() (in module flexlock.status_cli)
print_failed_tasks() (in module flexlock.status_cli)
print_status_summary() (in module flexlock.status_cli)
print_tags_breakdown() (in module flexlock.status_cli)
Project (class in flexlock)
(class in flexlock.api)
py2cfg() (in module flexlock)
(in module flexlock.utils)
Q
queue_tasks() (in module flexlock.taskdb)
R
raise_on_failure() (flexlock.api.ExecutionResult method)
reclaim_running() (in module flexlock.taskdb)
register_resolvers() (in module flexlock.resolvers)
render_script() (flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
reset_db() (in module flexlock.taskdb)
resolve_deferred() (in module flexlock.resolvers)
resolve_module_to_repo_path() (in module flexlock.utils)
resolve_swap() (in module flexlock.utils)
results_path (flexlock.run_record.RunRecord property)
run() (flexlock.FlexLockRunner method)
(flexlock.parallel.ParallelExecutor method)
(flexlock.runner.FlexLockRunner method)
run_comparison() (in module flexlock.diff_cli)
run_lock_resolver() (in module flexlock.resolvers)
run_resolver() (in module flexlock.resolvers)
run_stage() (flexlock.api.Project method)
(flexlock.Project method)
RunDiff (class in flexlock.diff)
RunRecord (class in flexlock.run_record)
S
sanitize_ref_name() (in module flexlock.git_utils)
save_snapshot() (flexlock.api.Project method)
(flexlock.Project method)
select_and_freeze_root_refs() (in module flexlock)
shadow_index() (in module flexlock.git_utils)
SKIPPED (flexlock.api.Status attribute)
SlurmBackend (class in flexlock.backends.slurm)
SlurmJob (class in flexlock.backends.slurm)
snapshot() (in module flexlock)
Status (class in flexlock.api)
status (flexlock.run_record.RunRecord property)
status() (flexlock.backends.pbs.PBSJob method)
(flexlock.backends.slurm.SlurmJob method)
submit() (flexlock.api.Project method)
(flexlock.backends.base.Backend method)
(flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
(flexlock.Project method)
(in module flexlock)
submit_chained() (flexlock.api.Project method)
(flexlock.Project method)
submit_config() (flexlock.api.Project class method)
(flexlock.Project class method)
submit_pipeline() (flexlock.api.Project method)
(flexlock.Project method)
SUBMITTED (flexlock.api.Status attribute)
SUCCESS (flexlock.api.Status attribute)
Swap (class in flexlock.utils)
sweep (flexlock.api.ChainedResult attribute)
T
TERMINAL_STATES (flexlock.backends.pbs.PBSBackend attribute)
(flexlock.backends.slurm.SlurmBackend attribute)
to_dictconfig() (in module flexlock.utils)
U
update_task_snapshot() (in module flexlock.taskdb)
V
validate_slurm_script() (in module flexlock.backends.slurm)
vinc_resolver() (in module flexlock.resolvers)
W
wait() (flexlock.backends.pbs.PBSJob method)
(flexlock.backends.slurm.SlurmJob method)
wait_for_job() (flexlock.backends.pbs.PBSBackend method)
(flexlock.backends.slurm.SlurmBackend method)
watch_status() (in module flexlock.status_cli)
worker_loop() (in module flexlock.worker)
world_size (flexlock.backends.base.JobEnvironment property)
write_error() (flexlock.run_record.RunRecord method)
write_lock() (flexlock.run_record.RunRecord method)
write_results() (flexlock.run_record.RunRecord method)