Curifactory
Usage
Installation
Getting Started
Components
Parameter files and parameter sets
Cache
Hashing Mechanics
Experiment Graph (DAG)
Reports
Configuration and directory structure
CLI Guide
Example Experiment
Tips and tricks
Curifactory Cookbook
Migration Guide
API
Args
Caching
DAG
Docker
Experiment
Hashing
Manager
Params
Procedure
Project
Record
Reporting
Staging
Store
Utils
Curifactory
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
add_params_combo_hash() (in module curifactory.hashing)
add_run() (curifactory.store.ManagerStore method)
aggregate() (in module curifactory.staging)
analyze() (curifactory.dag.DAG method)
ArtifactManager (class in curifactory.manager)
ArtifactRepresentation (class in curifactory.record)
artifacts (curifactory.dag.DAG attribute)
(curifactory.manager.ArtifactManager attribute)
B
build_docker() (in module curifactory.docker)
build_execution_tree_recursive() (curifactory.dag.DAG method)
build_execution_trees() (curifactory.dag.DAG method)
C
cache_path (curifactory.manager.ArtifactManager attribute)
cache_paths (curifactory.caching.Cacheable attribute)
Cacheable (class in curifactory.caching)
CacheAwareDict (class in curifactory.record)
CachersMismatchError
chain_rep() (curifactory.dag.ExecutionNode method)
check() (curifactory.caching.Cacheable method)
(curifactory.caching.FileReferenceCacher method)
check_git_dirty_workingdir() (in module curifactory.utils)
child_records() (curifactory.dag.DAG method)
collect_parameter_sets() (in module curifactory.experiment)
combo_hash (curifactory.record.Record attribute)
compute_hash() (in module curifactory.hashing)
conda_env (curifactory.manager.ArtifactManager attribute)
config (curifactory.manager.ArtifactManager attribute)
CONFIGURATION_FILE (in module curifactory.utils)
curifactory.caching
module
curifactory.dag
module
curifactory.docker
module
curifactory.experiment
module
curifactory.hashing
module
curifactory.manager
module
curifactory.params
module
curifactory.procedure
module
curifactory.project
module
curifactory.record
module
curifactory.reporting
module
curifactory.staging
module
curifactory.store
module
curifactory.utils
module
current_stage_name (curifactory.manager.ArtifactManager attribute)
D
DAG (class in curifactory.dag)
dependencies (curifactory.dag.ExecutionNode attribute)
determine_execution_list() (curifactory.dag.DAG method)
determine_execution_list_recursive() (curifactory.dag.DAG method)
DFReporter (class in curifactory.reporting)
display_all_reportables() (curifactory.manager.ArtifactManager method)
display_group_reportables() (curifactory.manager.ArtifactManager method)
display_info() (curifactory.manager.ArtifactManager method)
display_record_reportables() (curifactory.manager.ArtifactManager method)
display_reportable() (curifactory.manager.ArtifactManager method)
display_stage_graph() (curifactory.manager.ArtifactManager method)
display_stage_reportables() (curifactory.manager.ArtifactManager method)
dry (curifactory.manager.ArtifactManager attribute)
dry_cache (curifactory.manager.ArtifactManager attribute)
E
EDITORS (in module curifactory.utils)
EmptyCachersError
error (curifactory.manager.ArtifactManager attribute)
error_thrown (curifactory.manager.ArtifactManager attribute)
ExecutingWithSkippedInputError
execution_list (curifactory.dag.DAG attribute)
execution_trees (curifactory.dag.DAG attribute)
ExecutionNode (class in curifactory.dag)
experiment_name (curifactory.manager.ArtifactManager attribute)
experiment_run_number (curifactory.manager.ArtifactManager attribute)
ExperimentParameters (class in curifactory.params)
extension (curifactory.caching.Cacheable attribute)
extra_metadata (curifactory.caching.Cacheable attribute)
F
FigureReporter (class in curifactory.reporting)
FileReferenceCacher (class in curifactory.caching)
find_leaves() (curifactory.dag.DAG method)
G
generate_report() (curifactory.manager.ArtifactManager method)
get_all_param_sets() (curifactory.manager.ArtifactManager method)
get_artifact_filename() (curifactory.manager.ArtifactManager method)
get_artifact_path() (curifactory.manager.ArtifactManager method)
get_command_output() (in module curifactory.utils)
get_conda_env() (in module curifactory.utils)
get_conda_list() (in module curifactory.utils)
get_configuration() (in module curifactory.utils)
get_current_commit() (in module curifactory.utils)
get_dir() (curifactory.caching.Cacheable method)
(curifactory.record.Record method)
get_editor() (in module curifactory.utils)
get_experiment_runs() (curifactory.store.ManagerStore method)
get_grouped_reportables() (curifactory.manager.ArtifactManager method)
get_hash() (curifactory.record.Record method)
get_os() (in module curifactory.utils)
get_param_set_hash_values() (in module curifactory.hashing)
get_parameter_hash_value() (in module curifactory.hashing)
get_path() (curifactory.caching.Cacheable method)
(curifactory.record.Record method)
get_pip_freeze() (in module curifactory.utils)
get_py_opening_comment() (in module curifactory.utils)
get_record_string() (curifactory.dag.DAG method)
get_reference_name() (curifactory.manager.ArtifactManager method)
(curifactory.record.Record method)
get_run() (curifactory.store.ManagerStore method)
get_run_output_path() (curifactory.manager.ArtifactManager method)
get_str_timestamp() (curifactory.manager.ArtifactManager method)
get_ungrouped_reportables() (curifactory.manager.ArtifactManager method)
git_commit_hash (curifactory.manager.ArtifactManager attribute)
git_workdir_dirty (curifactory.manager.ArtifactManager attribute)
group (curifactory.reporting.Reportable attribute)
H
hash (curifactory.params.ExperimentParameters attribute)
hash_param_set() (in module curifactory.hashing)
hash_representations (curifactory.params.ExperimentParameters attribute)
hostname (curifactory.manager.ArtifactManager attribute)
html() (curifactory.reporting.DFReporter method)
(curifactory.reporting.FigureReporter method)
(curifactory.reporting.HTMLReporter method)
(curifactory.reporting.ImageReporter method)
(curifactory.reporting.JsonReporter method)
(curifactory.reporting.LatexTableReporter method)
(curifactory.reporting.LinePlotReporter method)
(curifactory.reporting.Reportable method)
html_safe() (curifactory.record.ArtifactRepresentation method)
html_string (curifactory.reporting.HTMLReporter attribute)
HTMLReporter (class in curifactory.reporting)
human_readable_mem_usage() (in module curifactory.utils)
human_readable_time() (in module curifactory.utils)
I
ignore_lazy (curifactory.manager.ArtifactManager attribute)
ImageReporter (class in curifactory.reporting)
init_logging() (in module curifactory.utils)
input_records (curifactory.record.Record attribute)
InputSignatureError
interactive (curifactory.manager.ArtifactManager attribute)
is_aggregate (curifactory.record.Record attribute)
is_leaf() (curifactory.dag.DAG method)
is_output_used_anywhere() (curifactory.dag.DAG method)
J
JsonCacher (class in curifactory.caching)
JsonReporter (class in curifactory.reporting)
K
kwargs (curifactory.reporting.FigureReporter attribute)
L
LatexTableReporter (class in curifactory.reporting)
Lazy (class in curifactory.caching)
lazy (curifactory.manager.ArtifactManager attribute)
LinePlotReporter (class in curifactory.reporting)
list_experiments() (in module curifactory.experiment)
list_params() (in module curifactory.experiment)
live_report_path_generated (curifactory.manager.ArtifactManager attribute)
load() (curifactory.caching.Cacheable method)
(curifactory.caching.FileReferenceCacher method)
(curifactory.caching.JsonCacher method)
(curifactory.caching.PandasCacher method)
(curifactory.caching.PathRef method)
(curifactory.caching.PickleCacher method)
(curifactory.caching.RawJupyterNotebookCacher method)
(curifactory.store.ManagerStore method)
lock() (curifactory.manager.ArtifactManager method)
logs_path (curifactory.manager.ArtifactManager attribute)
M
make_copy() (curifactory.record.Record method)
manager (curifactory.record.Record attribute)
manager_cache_path (curifactory.manager.ArtifactManager attribute)
ManagerStore (class in curifactory.store)
map_full_svg() (in module curifactory.reporting)
map_mode (curifactory.manager.ArtifactManager attribute)
map_records() (curifactory.manager.ArtifactManager method)
map_single_svg() (in module curifactory.reporting)
mapped_artifacts (curifactory.manager.ArtifactManager attribute)
metadata (curifactory.caching.Cacheable attribute)
module
curifactory.caching
curifactory.dag
curifactory.docker
curifactory.experiment
curifactory.hashing
curifactory.manager
curifactory.params
curifactory.procedure
curifactory.project
curifactory.record
curifactory.reporting
curifactory.staging
curifactory.store
curifactory.utils
N
name (curifactory.caching.Cacheable attribute)
(curifactory.params.ExperimentParameters attribute)
(curifactory.reporting.Reportable attribute)
NoArtifactManagerError
notebooks_path (curifactory.manager.ArtifactManager attribute)
notes (curifactory.manager.ArtifactManager attribute)
O
os (curifactory.manager.ArtifactManager attribute)
output (curifactory.record.Record attribute)
OutputSignatureError
overwrite (curifactory.manager.ArtifactManager attribute)
(curifactory.params.ExperimentParameters attribute)
overwrite_stages (curifactory.manager.ArtifactManager attribute)
P
PandasCacher (class in curifactory.caching)
PandasCsvCacher (class in curifactory.caching)
PandasJsonCacher (class in curifactory.caching)
parallel_lock (curifactory.manager.ArtifactManager attribute)
parallel_mode (curifactory.manager.ArtifactManager attribute)
param_file_param_sets (curifactory.manager.ArtifactManager attribute)
param_set_string_hash_representations() (in module curifactory.hashing)
parameter_files (curifactory.manager.ArtifactManager attribute)
PARAMETERS_BLACKLIST (in module curifactory.hashing)
params (curifactory.record.Record attribute)
params_hash() (curifactory.params.ExperimentParameters method)
parent (curifactory.dag.ExecutionNode attribute)
path (curifactory.reporting.Reportable attribute)
(curifactory.store.ManagerStore attribute)
path_override (curifactory.caching.Cacheable attribute)
PathRef (class in curifactory.caching)
PickleCacher (class in curifactory.caching)
pip_freeze (curifactory.manager.ArtifactManager attribute)
prefix (curifactory.caching.Cacheable attribute)
(curifactory.manager.ArtifactManager attribute)
PrefixedLogFactory (class in curifactory.utils)
prepare_report_path() (in module curifactory.reporting)
preview_object() (in module curifactory.utils)
print_experiment_map() (curifactory.dag.DAG method)
Procedure (class in curifactory.procedure)
Q
qualified_name (curifactory.reporting.Reportable attribute)
R
RawJupyterNotebookCacher (class in curifactory.caching)
Record (class in curifactory.record)
record (curifactory.caching.Cacheable attribute)
(curifactory.reporting.Reportable attribute)
records (curifactory.manager.ArtifactManager attribute)
regex_lister() (in module curifactory.experiment)
render() (curifactory.reporting.FigureReporter method)
(curifactory.reporting.ImageReporter method)
(curifactory.reporting.LinePlotReporter method)
(curifactory.reporting.Reportable method)
render_graph() (in module curifactory.reporting)
render_report_all_reportables() (in module curifactory.reporting)
render_report_argset_dump() (in module curifactory.reporting)
render_report_detailed_stage_maps() (in module curifactory.reporting)
render_report_head() (in module curifactory.reporting)
render_report_info_block() (in module curifactory.reporting)
render_report_reportables_toc() (in module curifactory.reporting)
render_report_stage_map() (in module curifactory.reporting)
render_report_toc() (in module curifactory.reporting)
render_reportable() (in module curifactory.reporting)
rendered (curifactory.reporting.Reportable attribute)
report() (curifactory.record.Record method)
report_css_path (curifactory.manager.ArtifactManager attribute)
Reportable (class in curifactory.reporting)
reportables (curifactory.manager.ArtifactManager attribute)
reports_path (curifactory.manager.ArtifactManager attribute)
reproduction_line (curifactory.manager.ArtifactManager attribute)
resolve (curifactory.record.CacheAwareDict attribute)
run() (curifactory.procedure.Procedure method)
run_command() (in module curifactory.utils)
run_experiment() (in module curifactory.experiment)
run_info (curifactory.manager.ArtifactManager attribute)
run_line (curifactory.manager.ArtifactManager attribute)
run_report() (in module curifactory.reporting)
run_timestamp (curifactory.manager.ArtifactManager attribute)
runs (curifactory.store.ManagerStore attribute)
runs_path (curifactory.manager.ArtifactManager attribute)
S
save() (curifactory.caching.Cacheable method)
(curifactory.caching.FileReferenceCacher method)
(curifactory.caching.JsonCacher method)
(curifactory.caching.PandasCacher method)
(curifactory.caching.PathRef method)
(curifactory.caching.PickleCacher method)
(curifactory.caching.RawJupyterNotebookCacher method)
(curifactory.store.ManagerStore method)
set_aggregate() (curifactory.record.Record method)
set_hash() (curifactory.record.Record method)
set_hash_functions() (in module curifactory.hashing)
set_logging_prefix() (in module curifactory.utils)
SkippedOutput (class in curifactory.staging)
stage (curifactory.caching.Cacheable attribute)
(curifactory.reporting.Reportable attribute)
stage() (in module curifactory.staging)
stage_active (curifactory.manager.ArtifactManager attribute)
stage_cachers (curifactory.record.Record attribute)
stage_inputs (curifactory.record.Record attribute)
stage_inputs_names (curifactory.record.Record attribute)
stage_kwargs_keys (curifactory.record.Record attribute)
stage_outputs (curifactory.record.Record attribute)
stage_suppress_missing (curifactory.record.Record attribute)
stages (curifactory.record.Record attribute)
state (curifactory.record.Record attribute)
state_artifact_reps (curifactory.record.Record attribute)
status (curifactory.manager.ArtifactManager attribute)
store() (curifactory.manager.ArtifactManager method)
store_full (curifactory.manager.ArtifactManager attribute)
store_tracked_paths() (curifactory.record.Record method)
stored (curifactory.manager.ArtifactManager attribute)
stored_paths (curifactory.record.Record attribute)
string_rep() (curifactory.dag.ExecutionNode method)
subdir (curifactory.caching.Cacheable attribute)
T
TIMESTAMP_FORMAT (in module curifactory.utils)
track (curifactory.caching.Cacheable attribute)
U
unlock() (curifactory.manager.ArtifactManager method)
unstored_tracked_paths (curifactory.record.Record attribute)
update_map_progress() (curifactory.manager.ArtifactManager method)
update_report_index() (in module curifactory.reporting)
update_run() (curifactory.store.ManagerStore method)
W
write_run_env_output() (curifactory.manager.ArtifactManager method)