open#

skore.open(project_path='project.skore', *, create=True, overwrite=False)[source]#

Open a project given a project name or path.

This function :

  • opens the project if it already exists,

  • creates the project if it does not exist,

  • and creates by overwriting a pre-existing project if overwrite is set to

True.

Parameters:
project_path: Path-like, default=”project.skore”

The relative or absolute path of the project.

create: bool, default=True

Whether or not to create the project, if it does not already exist.

overwrite: bool, default=False

Overwrite the project file if it already exists and create is True. Has no effect otherwise.

Returns:
Project

The opened Project instance.

Raises:
FileNotFoundError

If path is not found and create is set to False

ProjectCreationError

If project creation fails for some reason (e.g. if the project path is invalid)

On this page
Show Source