Open existing projects#

In this guide, we will walk through the different modes for interacting with an existing project.

Read-only mode#

If you open a lazyscribe.project.Project with mode="r", all experiments will be loaded into a lazyscribe.experiment.ReadOnlyExperiment class. You cannot

  1. set any attributes directly for an experiment,

  2. save the project file, or

  3. add any experiments to the project.

Tests within a ReadOnlyExperiment are likewise loaded as lazyscribe.test.ReadOnlyTest instances. Attempting to call log_metric(), log_parameter(), or log_artifact() on a ReadOnlyTest will raise attrs.exceptions.FrozenInstanceError.

Append mode#

If you open a project with mode="a", all existing experiments will be loaded in read-only mode. However, you can add new experiments to the project and save the updated project JSON.

Editable mode#

If you open a project with mode="w+", you have complete control. All experiments will be loaded into an editable lazyscribe.experiment.Experiment class and you can make any changes.

Note

When you save the project, the last_updated_by experiment attribute will be updated to match the author that opened the project in editable mode.