Projects allow you to group your Training Runs and AI Experiments when using the AI Module. This tutorial will help you create your first Project and configure your environment to use it.
In order to use the AI Module, you must first create a Project. You can create a new project from the Projects page, using the CLI with
sigopt create project --project=my_first_project, or directly in a Python interpreter with
sigopt.create_project("my_first_project"). You may need to install the latest version of SigOpt to use these features.
After you create a Project you have a few options to configure your environment to use it. The options are listed in ascending order of precedence, i.e.,
sigopt.set_projectwill configure the Project regardless of the other options and the current directory name will always be considered last.
Create a directory with the same name as the Project's ID. When you run commands in this directory SigOpt will automatically associate your Training Runs and AI Experiments with the Project that matches the directory's name.
If you have access to a terminal, set the
SIGOPT_PROJECTenvironment variable to configure your Project.
$ export SIGOPT_PROJECT=my_first_project
When using the CLI, you can configure the Project for each command with the
$ sigopt run --project=my_first_project python ./my_run.py
In your code, use the
sigopt.set_projectfunction to configure the Project for a single session. This is especially useful in an interactive Python environment like IPython or Jupyter.