Under project settings you can configure the following:
- General settings
- Adding or Removing collaborators
- Linking/Unlinking git repositories
- Setting default values for experiments executions
- Configuring Webhooks
- Deleting a project
This guide will elaborate on how to configure each of those parts.
Note: To open your project setting, go to your project and click on Setting on the right upper corner, as marked here:
In the main Project screen, you can change the description, the visibility of the project and you can delete the project
After changing description or visibility ,click on Save to save changes/
When you create a private project, only you can see it (beside your organization admin). collaborators are members of the organisation that you can add to the project.
To add a new collaborator enter his name and click on Save.
If you don't see the email of the user you want to add in the list of suggestions, it might be that the user is not part of the organization and your organization admin need to add that user to the organization.
In this section you can connect your project to a public or private git repository.
in order to to so, add the following:
- Git repo clone url
- default branch to use (if not specified - 'master' branch will be used)
- if you choose to link a private repository - add your private key (i.e the key will start with -----BEGIN RSA PRIVATE KEY----- and will end with -----END RSA PRIVATE KEY-----)
- Click on Save
- Upon saving we will validate Git repos and credentials
You can set default parameters to the project, so every time you initiate an experiment it will take default values form the project setting. That could speed up the executing of experiments.
Default parameters can be set to:
- Image- The image you want you run the experiment on
- Compute- The default compute to start the experiment
- Environment Variables - add environment variables to the docker environment as KEY=VALUE. i.e PYTHON_HOME=/opt/python/bin
- Restart if stuck - if ON, every experiment that is IDLE for more the 'idle time' that is defined (see below), cnvrg will sync the current state and will restart the experiment.
- Max Restarts - when
Restart if stuckis ON, you can set the number of restarts per each experiment.
- Idle Time - the amount of minutes an experiment hasn't progressed and will be defined as Idle - default: 60 minutes
- AutoSync - If ON - cnvrg will sync an experiment every 'sync time' that is defined below
- Sync Time - every X minutes to sync the experiment
- On Spot Termination -If ON, when cnvrg identifies a spot has been taken, it will restart the experiment
Click Save to save changes
For each experiment, you can define a webhook that when experiment finishes to run it will post to the defined webhook URL the new state of the experiment.
Enter the url of the webhook, and click Save.
Every time an experiment finishes to run it will post a notify to that link