Metadata
Was this helpful?
Was this helpful?
Metadata contains detailed information about the entire research project, including the title, research field, description, project authors, and tags. Metadata is necessary to release a Capsule and enables quicker search results by using a keyword search. All the information is indexed for searching on the Code Ocean Internal Release page.
The metadata folder has the path of /metadata in a Capsule, which is invisible in a Reproducible Run, but accessible in any Cloud Workstation.
Click the metadata folder to open the metadata editor.
Enter the information in the text fields provided:
Name: This is the title of the Capsule. Use a name that's easy to search and understand for both you and others in the future. Conform to your company’s internal project naming conventions.
Research field: Enter the relevant research field.
Description: Describe what the Capsule is about to help yourself or your colleagues understand it in the future.
Authors: Enter the names of the people who created the Capsule.
Tags: Enter keywords that people might search on to help them find the Capsule in the future.
Most of the information you enter in the metadata editor is stored in the metadata.yml file. It can be opened and edited directly as a text file.
The Capsule ID is listed on the metadata page. Click the clipboard to copy this ID. This ID is required for certain APIs, for example, the run Capsule API.
To increase discovery and intelligibility on Code Ocean's Internal Releases Dashboard, a representative image can be added on the metadata page. To update your Capsule's cover image:
Navigate to your Capsule's Metadata folder.
Hover over the current image.
Click Upload Image.
