> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard

> Manage project settings, visibility, collaborators, README content, performance options, and API credentials.

The dashboard holds the project's ID, visibility, and collaborators, the project-wide settings that affect other pages, and actions that can't be undone.

Two of these settings affect other pages. The labeling method determines which learning blocks you can add to an impulse, so if a learning block you expect is missing, check this setting first. The target device sets the hardware used for the latency and memory estimates across Studio, so set it to the device you plan to deploy to.

<Frame caption="The dashboard, with each widget numbered to match the sections below.">
  <img src="https://mintcdn.com/edgeimpulse/UMiv9oezYdq-CZ8W/.assets/images/studio-dashboard-v2.png?fit=max&auto=format&n=UMiv9oezYdq-CZ8W&q=85&s=984cd1ea236b2f530233d6e59697d63a" alt="Project dashboard with ten numbered regions: getting started, sharing, run this model, collaborators, about this project, project info, download block output, performance settings, administrative zone, and danger zone" width="398" height="1000" data-path=".assets/images/studio-dashboard-v2.png" />
</Frame>

The numbered regions map to the sections below. Where the Studio uses a different label, it follows in brackets.

1. [Getting started](#getting-started)
2. [Project visibility](#project-visibility) (Sharing)
3. [Run this model](#run-this-model)
4. [Collaboration](#collaboration) (Collaborators)
5. [Project README](#showcasing-your-public-projects-with-markdown-readmes) (About this project)
6. [Project info](#project-info)
7. [Block outputs](#block-outputs) (Download block output)
8. [Performance settings](#performance-settings)
9. [Administrative zone](#administrative-zone)
10. [Danger zone](#danger-zone)

The unnumbered **Summary** widget reports connected [devices](/studio/projects/devices) and collected [data](/studio/projects/data-acquisition).

## Getting started

The Getting Started section is here to help. You can choose from 3 different options to get started:

* **Add existing data**: When selecting this option, you can then choose to **Upload data** from your computer or to **Add storage bucket**
* **Collect new data**: When selecting this option, the getting started guide will ask you to either **Scan QR code to connect to your phone**, **Connect to your computer**, or to **Connect your device or developer board**. Make sure that your device or development board is flashed with the Edge Impulse official firmware.
* **Upload your model**: This option will change the default workflow. See [BYOM](/studio/projects/dashboard/byom) to learn more about how to import your existing model to Edge Impulse studio.

## Project visibility

You have two options for your project's visibility:

### Private

Private projects are only visible to you in your developer profile or, if you are on the Enterprise plan, within your organization. There are limits to the number of private projects a developer or enterprise may have. Please refer to our [plans and pricing](https://edgeimpulse.com/pricing) page on our website for details.

### Public

When a project is public, all of your data, block configurations, intermediate results, and final models will be shared with the world. Your project will be publicly accessible and can be cloned with a single click with the provided URL. There are no limits to the amount of public projects a developer or enterprise may have.

<Frame caption="A public project in the Edge Impulse Studio.">
  <img src="https://mintcdn.com/edgeimpulse/sFtdfPhSpbLZ2-cz/.assets/images/studio-public-project.png?fit=max&auto=format&n=sFtdfPhSpbLZ2-cz&q=85&s=5ef3b06d89085f779c028ffef9cce0ad" alt="Public project dashboard with visibility settings and sharing information" width="874" height="580" data-path=".assets/images/studio-public-project.png" />
</Frame>

<Info>
  **List your project in the public project repository**

  If you want to reference your project in the Edge Impulse [public project repository](https://edgeimpulse.com/projects/overview), you can go to the [versioning](/studio/projects/versioning) page, create a version and check the **Publish this version under the Apache 2.0 license**.

  This is a great way to share your work with the community.
</Info>

## Run this model

When you have a trained model available in your project, this card will appear to let you test your model with your phone or your computer. This is particularly useful to validate the behaviour of your model before integrating it into your targeted embedded firmware.

## Collaboration

To add a collaborator, go to your project's dashboard and find the "Collaborators" widget. Click the '**+**' icon and type the username or e-mail address of the other user. The user will be invited to create an Edge Impulse account if it doesn't exist.

The user will be automatically added to the project and will get an email notification inviting them to start contributing to your project. To remove a user, simply click on the three dots beside the user then tap ‘Delete’ and they will be automatically removed.

There are different limits for how many collaborators can be added to project depending on its visibility (public or private) and the pricing plan it is associated with (Developer plan or Enterprise plan). Please refer to our [plans and pricing](https://edgeimpulse.com/pricing) page on our website for details.

<Frame caption="Collaborators">
  <img src="https://mintcdn.com/edgeimpulse/UMiv9oezYdq-CZ8W/.assets/images/studio-collaboration.png?fit=max&auto=format&n=UMiv9oezYdq-CZ8W&q=85&s=3cb0262de42e664bce6a11c82919a11a" alt="Collaborators widget for inviting and managing project collaborators" width="780" height="652" data-path=".assets/images/studio-collaboration.png" />
</Frame>

## Showcasing your public projects with Markdown READMEs

The project README enables you to explain the details of your project in a short way. Using this feature, you can add visualizations such as images, GIFs, code snippets, and text to your project in order to bring your colleagues and project viewers up to speed with the important details of your project. In your README you might want to add things like:

* What the project does
* Why the project is useful
* Motivations of the project
* How to get started with the project
* What sensors and target deployment devices you used
* How you plan to improve your project
* Where users can get help with your project

To create your first README, navigate to the "about this project" widget and click "add README"

<Frame caption="The Edge Impulse Studio project README.">
  <img src="https://mintcdn.com/edgeimpulse/qzz8ALldRag_9UsW/.assets/images/add-a-readme.png?fit=max&auto=format&n=qzz8ALldRag_9UsW&q=85&s=9d93acb40903e7afb3354f7ef5fbefa9" alt="Project README editor and preview area on the dashboard" width="1600" height="175" data-path=".assets/images/add-a-readme.png" />
</Frame>

For more README inspiration, check out the public Edge Impulse project tutorials below:

* [Keyword spotting](https://studio.edgeimpulse.com/public/14225/latest).
* [Continuous motion recognition](https://studio.edgeimpulse.com/public/14299/latest).
* [Image classification](https://studio.edgeimpulse.com/public/14227/latest).
* [Sound recognition](https://studio.edgeimpulse.com/public/14301/latest).

## Project info

The project info widget shows the project's specifications such as the project ID, labeling method, and latency calculations for your target device.

<Frame caption="Edge Impulse Studio project information.">
  <img src="https://mintcdn.com/edgeimpulse/iTt6mNOXOy0YNrkb/.assets/images/project-info.png?fit=max&auto=format&n=iTt6mNOXOy0YNrkb&q=85&s=a3aae77251a518611dfcb28815f93f40" alt="Project information panel with name, description, and metadata fields" width="1176" height="602" data-path=".assets/images/project-info.png" />
</Frame>

* The project ID is a unique numerical value that identifies your project. Whenever you have any issue with your project on the studio, you can always share your project ID on the [forum](https://forum.edgeimpulse.com/) for assistance from edge Impulse staff.
* On the labeling method dropdown, you need to specify the type of labeling your dataset and model expect. This can be either one label per data item or bounding boxes. Bounding boxes only work for object detection tasks in the studio. Note that if you interchange the labeling methods, learning blocks will appear to be hidden when building your impulse.
* The latency calculation component estimates the approximate time in milliseconds that the trained model and DSP operations are going to take during inference based on the selected target device. This hardware in the loop approach ensures that the target deployment device compute resources are not underutilized or over-utilized. It also saves developers' time associated with numerous inference iterations back and forth the studio in search of optimum models.

## Block outputs

In the **Block output** section, you can download the results of the DSP and ML operations of your impulse.

<Frame caption="Download Edge Impulse Studio project block output.">
  <img src="https://mintcdn.com/edgeimpulse/FtCF_ajfwASxt-xU/.assets/images/download-block-output.png?fit=max&auto=format&n=FtCF_ajfwASxt-xU&q=85&s=14340c786377f87621bdaa36936734de" alt="Block output download area for exporting intermediate project files" width="1095" height="1000" data-path=".assets/images/download-block-output.png" />
</Frame>

The downloadable assets include the extracted features, Tensorflow SavedModel, and both quantized and unquantized LiteRT (previously Tensorflow Lite) models. This is particularly helpful when you want to perform other operations to the output blocks outside the Edge Impulse studio. For example, if you need a TensorflowJS model, you will just need to download the TensorFlow saved model from the dashboard and convert it to TensorFlowJS model format to be served on a browser.

## Performance settings

<Info>
  **Only available on the Enterprise plan**

  This feature is only available on the Enterprise plan. Review our [plans and pricing](https://edgeimpulse.com/pricing) or sign up for our free [expert-led trial](https://edgeimpulse.com/expert-led-trial) today.
</Info>

These settings control how Edge Impulse runs your jobs. They change how long training and feature generation take, but they don't change the resulting model.

<Frame caption="The Edge Impulse Studio project performance settings.">
  <img src="https://mintcdn.com/edgeimpulse/-WgXP515XHSZ7nhZ/.assets/images/project-performance-settings-panel-with-processing.png?fit=max&auto=format&n=-WgXP515XHSZ7nhZ&q=85&s=0105b20a1620c8a094713ec59053b4df" alt="Project performance settings panel with processing and training options" width="694" height="514" data-path=".assets/images/project-performance-settings-panel-with-processing.png" />
</Frame>

<Note>
  GPU training and parallel DSP jobs are experimental and are not enabled for every organization.
</Note>

## Administrative zone

To bring even more flexibility to projects, the administrative zone gives developers the power to enable other additional features that are not found in edge impulse projects by default. Most of these features are usually advanced features intended for organizations or sometimes experimental features.

Check the boxes for the features you want and save. These features are experimental and can behave differently from the documented defaults.

## Danger zone

<Frame caption="Edge Impulse Studio project danger zone settings.">
  <img src="https://mintcdn.com/edgeimpulse/UMiv9oezYdq-CZ8W/.assets/images/studio-dashboard-danger-zone.png?fit=max&auto=format&n=UMiv9oezYdq-CZ8W&q=85&s=ddb8037195b531892753fab64a3293c9" alt="Danger zone settings for clearing or deleting project resources" width="1468" height="928" data-path=".assets/images/studio-dashboard-danger-zone.png" />
</Frame>

The danger zone widget consists of irrevocable actions that let you to:

* Perform train/test split. This action re-balances your dataset by splitting all your data automatically between the training and testing set and resets the categories for all data.
* Launch the getting started wizard. This will remove all data, and clear out your impulse.
* Transfer ownership. This action is available for users who have one or more organizations linked with their accounts. With it, you can start working on a project with your user profile and then transfer the ownership to your organization.
* Delete your project. This action removes all devices, data, and impulses from your project.
* Delete all data in this project.

## API keys

The **Keys** tab in the dashboard lets you manage API keys and HMAC keys for your project. See [API keys](/studio/projects/dashboard/api-keys) for full details.

## API reference

| Endpoint | Use |
| - | - |
| [Project information](/apis/studio/projects/project-information) | Read a project's settings, including its labeling method and target device |
| [Update project](/apis/studio/projects/update-project) | Change project settings programmatically |
| [List active projects](/apis/studio/projects/list-active-projects) | Enumerate the projects you have access to |
| [Add collaborator](/apis/studio/projects/add-collaborator) | Invite a user to the project |
| [Remove collaborator](/apis/studio/projects/remove-collaborator) | Revoke a user's access |

## Additional resources

* [API keys](/studio/projects/dashboard/api-keys) for authenticating against the project
* [Bring your own model](/studio/projects/dashboard/byom) for importing an existing model
* [Versioning](/studio/projects/versioning) for publishing a project to the public repository
