aquin.recipe.store Namespace Reference

Functions
Path	run_root (Path|None cwd=None)
Path	revision_dir (str rev_id, *, Path|None cwd=None)
Path	run_dir (str run_id, *, Path|None cwd=None)
str	hash_file (Path path)
int|None	_count_rows (Path path, str fmt)
list[str]|None	_csv_columns (Path path)
DataRevision	capture_revision (str|Path path, *, bool snapshot=False, Path|None cwd=None)
None	write_json (Path path, Any payload)
Path	save_run (RunRecord record)
RunRecord	load_run (str run_id, *, Path|None cwd=None)

Variables
str	RUN_ROOT_NAME = "aquin_run"

Function Documentation

_count_rows()

int | None _count_rows ( Path path, str fmt )

protected

Definition at line 48 of file store.py.

Referenced by capture_revision().

_csv_columns()

list[str] | None _csv_columns ( Path path )

protected

Definition at line 62 of file store.py.

Referenced by capture_revision().

capture_revision()

DataRevision capture_revision	(	str | Path	path,
		*	,
		bool	snapshot = False,
		Path | None	cwd = None )

Definition at line 71 of file store.py.

References _count_rows(), _csv_columns(), hash_file(), and revision_dir().

hash_file()

str hash_file

(

Path

path

)

Definition at line 37 of file store.py.

Referenced by capture_revision().

load_run()

RunRecord load_run	(	str	run_id,
		*	,
		Path | None	cwd = None )

Definition at line 131 of file store.py.

References run_dir().

revision_dir()

Path revision_dir	(	str	rev_id,
		*	,
		Path | None	cwd = None )

Definition at line 29 of file store.py.

References run_root().

Referenced by capture_revision().

run_dir()

Path run_dir	(	str	run_id,
		*	,
		Path | None	cwd = None )

Definition at line 33 of file store.py.

References run_root().

Referenced by load_run().

run_root()

Path run_root

(

Path | None

cwd = None

)

Definition at line 25 of file store.py.

Referenced by revision_dir(), and run_dir().

save_run()

Path save_run

(

RunRecord

record

)

Definition at line 116 of file store.py.

References write_json().

write_json()

None write_json	(	Path	path,
		Any	payload )

Definition at line 111 of file store.py.

Referenced by save_run().

Variable Documentation

RUN_ROOT_NAME

str aquin.recipe.store.RUN_ROOT_NAME = "aquin_run"

Definition at line 22 of file store.py.