Environment Variables
You can find in the below table the Environment variables that AIchor lets you use and some examples.
"Slugs" are strings without special characters expect hyphens - .
They are suitable for use in urls, docker images or tags.
| Environment Variable Name | Description | Example value |
|---|---|---|
| AICHOR_USER_NAME | Experiment actor name | |
| AICHOR_USER_EMAIL | Experiment actor email address | |
| AICHOR_PROJECT_ID | AIchor project ID | e7be88af-7621-4574-aa61-e810679b69d4 |
| AICHOR_ORGANIZATION_NAME | Current organization name | instadeep |
| AICHOR_ORGANIZATION_ID | Current organization ID | org_wa4GMsQSU1ZrZ921 |
| AICHOR_CLUSTER_NAME | Current cluster name | AIchor |
| AICHOR_CLUSTER_ID | Current cluster ID | 31ed1de8-c937-40ea-b5c8-d17eecb12ec1 |
| AICHOR_EXPERIMENT_ID | AIchor experiment ID | e2b53b98-975d-4be7-9f5b-8dfd6b765d32 |
| AICHOR_INPUT_PATH | Input bucket path | s3://project-name-e7be88af76214574-inputs/ |
| AICHOR_OUTPUT_PATH | Output recommended path (in the output bucket) | s3://project-name-e7be88af76214574-outputs/output/e2b53b98-975d-4be7-9f5b-8dfd6b765d32/ |
| AICHOR_LOGS_PATH | Tensorboard logs recommended path (in the output bucket) | s3://project-name-e7be88af76214574-outputs/logs/e2b53b98-975d-4be7-9f5b-8dfd6b765d32/ |
| VCS_TYPE | VCS Repository type | gitlab, github or bitbucket |
| VCS_URL | Url of the remote git repository | |
| VCS_REPOSITORY | Full repository path, with owner, groups and name | instadeep/group/subgroup/repo |
| VCS_REPOSITORY_SLUG | Slugified VCS_REPOSITORY | instadeep-group-subgroup-repo |
| VCS_REPOSITORY_OWNER | First subpath of the repository url, usually a username | instadeep |
| VCS_REPOSITORY_OWNER_SLUG | Slugified VCS_REPOSITORY_OWNER | instadeep |
| VCS_REPOSITORY_GROUPS | Intermediate subpaths of the repository url | group/subgroup |
| VCS_REPOSITORY_GROUPS_SLUG | Slugified VCS_REPOSITORY_GROUPS | group-subgroup |
| VCS_REPOSITORY_NAME | Last subpath of the repository url | repo |
| VCS_REPOSITORY_NAME_SLUG | Slugified VCS_REPOSITORY_NAME | repo |
| VCS_REF | Git reference of branch or tag | refs/heads/current-branch-name |
| VCS_REF_SLUG | Slugified VCS_REF | refs-heads-current-branch-name |
| VCS_REF_NAME | Name of branch or tag | current-branch-name |
| VCS_REF_NAME_SLUG | Slugified VCS_REF_NAME | current-branch-name |
| VCS_SHA | Git commit sha | ffac537e6cbbf934b08745a378932722df287a53 |
| VCS_SHA_SHORT | Git shortened commit sha | ffac537e |
| VCS_AUTHOR_NAME | Git commit author name | |
| VCS_AUTHOR_EMAIL | Git commit author email address | |
| VCS_COMMIT_MESSAGE | Full Git commit message | |
| VCS_COMMIT_MESSAGE_SHORT | First line of the Git commit message | |
| S3_ENDPOINT | Endpoint to the AIchor generated S3 buckets | https://storage.googleapis.com |
| AWS_ACCESS_KEY_ID | AWS key for configuring S3 automatically | |
| AWS_SECRET_ACCESS_KEY | AWS secret for configuring S3 automatically |
Additional points
- You can add env variables via AIchor UI on the project view. Those variables will be available when running an experiment on AIchor:
- In your AIchor project, go the “Variables” tab > “Create new variable”
- If you define a variable with the same name of the predefined env variable (see above), the value available in your docker will be the value defined in the UI.
- If you want to use tensorboard, you can save all the logs into the directory specified via
AICHOR_LOGS_PATHenv variable and then use the tensorboard's integration from AIchor:- go to your experiment page
- "View Tensorboard" button on the top right.