Skip to content

Projects

A Project in Lynxius is the central entity that groups evaluation runs' results. A Project typically represents a single application in a specific environment (e.g., Development, Test, User Acceptance Testing (UAT), Staging and Production) and/or location (e.g., Washington, Zurich, and Singapore). On the other hand, projects can be use as they best fit your organization or use-case.

A Project can contain one or multiple members. Each can be either a PROJECT-OWNER or a PROJECT-PARTICIPANT. They can manage the project by generating API keys for it and running evaluations for that project.

The project's evaluation analytics are visible on the plots of the Trends page, while the organization's Datasets are a good way to run bulk evaluations and collaborate with the Subject Matter Experts (SMEs) that typically annotate your data entries with high quality human labels and scores.

What are Projects?

Create a new Project

To create a new project, click the Create a Project button on the projects page. You will be prompted to insert the name for that project. Make sure to set your default organization first.

If you created the project, you become the PROJECT-OWNER and you can add new PROJECT-PARTICIPANTs.

Create a new API Key

To run evaluations you need to create an API key on the API key page by clicking on the Create API Key button. You will be prompted to select the project you wish to create the key for and insert the name for that key.

Warning

Rememeber to store your secret key somewhere safe, you won't be able to access it again.

If you run Lynxius from your GitHub Actions pipelines, for example, the best way to store this secret is using GitHub encrypted secrets.

Check out the setup page to learn how to use the newly generated secret key to set up your project API key locally, or on your server, to start your LLM evaluations.