LineaPy Configuration

[mingjerli]

In PR #658

• We've implemented lineapy.options.set to enable changing the LineaPy backend database and where artifacts are saved.

This is useful if we want to switch between different artifact stores (for instance if we are sharing our artifacts with someone else). This is especially helpful if we are not starting LineaPy from the command line (for instance if we are using Google Colab or hosted Jupyter Hub). This can be achieved by running the following commands in your notebook

lineapy.options.set('database_url', 'NEW DATABASE CONNECTION STRING')
lineapy.options.set('artifact_storage_dir', 'NEW FOLDER LOCATION')

Note that, this command is only making sense to run at the beginning of your notebook since LineaPy is eagerly saving your execution graph into the LineaPy backend database. Switching the database is implicitly assumed you are in a new execution graph and your notebook session will be reset after you change the backend database.

Tip: We want to make sure the relationship between LineaPy backend database and where artifacts are saved is one-to-one. Otherwise, the LineaPy artifact store might have trouble retrieving some artifacts.

• We've also streamlined to process to manage LineaPy configuration.

We can now use a configuration file, environment variables, or CLI options to start the LineaPy instance with different configurations.
Furthermore, you can use lineapy --options init to create the configuration file and make these changes persistent without setting them every time. You can look at available LineaPy configuration items or if you want to learn more about LineaPy configuration generally. Please see LineaPy Configuration Referenece.