Skip to content

Project

project

Project

name = path.name instance-attribute

base_path = path / '.octoflow' instance-attribute

experiments property

__init__(path: Union[str, Path]) -> None

get_repo() -> Generator[Repo, None, None]

sync(message: Optional[str] = None) -> str

project

ProjectExperiment

get_project = weakref.ref(project) instance-attribute
expr_name = expr_name instance-attribute
project: Project property
__init__(project: Project, expr_name: str) -> None
start_run(force: bool = False, description: Optional[str] = None) -> Run

ProjectExperimentDict

Bases: Mapping[str, ProjectExperiment]

get_project = weakref.ref(project) instance-attribute
project: Project property
experiments_path: Path property
names: Set[str] property
__init__(project: Project) -> None
__iter__()
__getitem__(key: str) -> ProjectExperiment
__contains__(key: str) -> bool
__len__() -> int
__repr__() -> str
first() -> ProjectExperiment

Project

name = path.name instance-attribute
base_path = path / '.octoflow' instance-attribute
experiments property
__init__(path: Union[str, Path]) -> None
get_repo() -> Generator[Repo, None, None]
sync(message: Optional[str] = None) -> str

update_project_gitgnore(path: Path) -> None