> For the complete documentation index, see [llms.txt](https://docs.unitlab.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.unitlab.ai/documentation/releases/create-a-release.md).

# Create a release

Create a release from a project, choose its format and split, and download it.

## Before you begin

* The work you want to deliver has passed review.
* You need the **Manage releases** permission.

{% hint style="warning" %}
A release includes the latest labels of every eligible item in the scope you pick. It doesn't check that each item was approved. If some items are still unreviewed, pick a scope without them, for example a Batch Queue that has been fully reviewed.
{% endhint %}

## Create the release

<figure><img src="https://292810646-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGjVLUz4wthGkGlRKM6rM%2Fuploads%2FpJgPzn1ebNWdc2Jm8xwC%2Frelease-create-modal.webp?alt=media" alt="Release dialog with scope, data types, format, distribution and the export token option" width="600"><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Open the dialog

Open the project, select **Releases**, then **Release**.
{% endstep %}

{% step %}

### Choose the scope

Select **Whole project** or one or more **Batch Queues**. The dialog shows how many annotated items are eligible.
{% endstep %}

{% step %}

### Choose data types and format

Tick the data types to include and pick a format for each, for example **COCO** for images. See [Export formats](https://docs.unitlab.ai/documentation/releases/export-formats-and-source-inclusion.md).
{% endstep %}

{% step %}

### Set the split

Under **Distribution**, set **Train**, **Valid** and **Test**. They must add up to 100. Choose train 100 if you'll split the data yourself. See [Release splits](https://docs.unitlab.ai/documentation/releases/release-splits-and-grouped-data.md).
{% endstep %}

{% step %}

### Optional settings

Pick a license if you need one. Turn on **Include export token URL** to add a permanent link to each source file in the export. Anyone with the link can open the file, so keep the export private.
{% endstep %}

{% step %}

### Create it

Select **Create release**. Wait until the status is **Ready**, then download.
{% endstep %}
{% endstepper %}

## Release status

| Status        | Meaning                                                |
| ------------- | ------------------------------------------------------ |
| **Pending**   | Queued, or the snapshot is being taken.                |
| **Exporting** | The labels are frozen and the files are being written. |
| **Ready**     | You can download it.                                   |
| **Failed**    | Something went wrong. Check the error and retry.       |

Large releases can take a while. Don't create a second release while you wait; check the status of the first.

## What gets included

* Items whose latest labels use the project's classes, or are marked as intentionally empty.
* Not included: items with invalid labels, archived items, and files that failed to upload.
* A [Data Group](https://docs.unitlab.ai/documentation/data/data-groups-and-layouts.md) is released as one unit, and always stays in one split.

The snapshot is taken when processing starts, not when you click. Avoid editing the items in scope until the status is **Exporting**.

## Downloads

Annotations and source files are separate downloads. A YOLO export, for example, doesn't include the images. Download links expire after a while; open the release again for a fresh one.

## Releases from cloud storage

If the files come from your own connected storage, such as Amazon S3, Unitlab also writes the export into that storage, under the connection's folder. The connection needs write access. To send it somewhere else, download it and copy it yourself.

## Automate it

* [Create and download releases with Python](https://docs.unitlab.ai/api-sdk-cli/sdks/create-and-download-releases)
* [Releases API](https://docs.unitlab.ai/api-sdk-cli/apis/releases-api)

## Related

[Export formats and source inclusion](https://docs.unitlab.ai/documentation/releases/export-formats-and-source-inclusion.md) · [Inspect, download, and validate](https://docs.unitlab.ai/documentation/releases/inspect-download-and-validate.md) · [Review, rework, and escalation](https://docs.unitlab.ai/documentation/workflows/review-rework-and-escalation.md)
