Create Project#

You can create a project through the NeMo Entity Store microservice to organize your models, datasets, and customization jobs.

Prerequisites#

Before you can create a project, make sure that you have:

  • Obtained the base URL of the NeMo Entity Store microservice.

  • Permissions to access the NeMo Entity Store microservice endpoint.

  • Obtained the id of the namespace you want to use for the project.

To Create a Project#

Choose one of the following options of creating a project.

Set up a NeMoMicroservices client instance using the base URL of the NeMo Entity Store microservice and perform the task as follows.

from nemo_microservices import NeMoMicroservices

client = NeMoMicroservices(
    base_url=os.environ["ENTITY_STORE_BASE_URL"]
)

response = client.projects.create(
  name="your-project-name",
  description="your-project-description",
  namespace="your-namespace", # Namespace that you create using NeMo Entity Store
  custom_fields={
    "team": "your-team",
    "priority": "your-priority",
    "status": "your-status",
    "target_completion": "your-target-completion",
  },
  ownership={"created_by": "your-email", "access_policies": {}},
)
print(response)

Make a POST request to the /v1/projects endpoint.

export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>

curl -X POST "${ENTITY_STORE_BASE_URL}/v1/projects" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "your-project-name",
      "description": "your-project-description",
      "namespace": "your-namespace", # Namespace that you create using NeMo Entity Store
      "custom_fields": {
          "team": "your-team",
          "priority": "your-priority",
          "status": "your-status",
          "target_completion": "your-target-completion"
      },
      "ownership": {
          "created_by": "your-email",
          "access_policies": {}
      }
    }' | jq
Example Response
{
  "created_at": "2025-02-12T17:00:33.795767",
  "updated_at": "2025-02-12T17:00:33.795769",
  "name": "Documentation Test Project",
  "description": "A project for documentation testing",
  "namespace": "docs",
  "custom_fields": {
    "team": "documentation",
    "priority": "high",
    "status": "in-progress",
    "target_completion": "2024-03-31"
  },
  "ownership": {
    "created_by": "user@nvidia.com",
    "access_policies": {}
  }
}