About Managing Entities#

Entities are objects that you create and manage while using the NeMo microservices. They include projects, namespaces, datasets, models, job configurations, job information, job results, and more. Some entities are specific to microservices, while others are shared across multiple microservices.

  • General entities: Some entities are shared between multiple microservices. These include namespaces, projects, datasets and models. The NeMo Entity Store microservice helps you manage these general entities.

  • Service-specific entities: Some entities are specific to a particular microservice. For example, evaluation targets, evaluation configurations, evaluation jobs and evaluation results are specific to the NeMo Evaluator microservice.

Entities like models, datasets, and job artifacts need to reference files. The NeMo Data Store microservice serves as the default file storage solution for the NeMo microservices platform, exposing APIs compatible with the Hugging Face Hub client (HfApi).

Among the general entities, namespaces and projects are organizational entities that help you structure all other entities and files in a logical way, allowing organization by user, team, or other criteria.

To learn more about entities and core concepts around them, see Entity Concepts before proceeding.

In this chapter, you learn how to manage entities such as namespaces, projects, datasets, and models by making requests to the NeMo Entity Store and NeMo Data Store microservices.


Tutorials#

Follow these tutorials to learn how to accomplish common entity management tasks.

Set Up Project Entities (API)

Set up your project entities using the NeMo Entity Store APIs.

Set Up Organizational Entities
Manage Dataset Files (HF)

Manage dataset files using the Hugging Face CLI or SDK and register them to NeMo Data Store.

Create Dataset Files

API Usage Guides#

The following guides provide detailed information on how to perform common entity management operations using the NeMo microservices platform.

Namespaces

Create, update, and manage namespaces that group related entities by dimensions like team or product.

Namespaces
Projects

Create, update, and manage projects that organize your datasets, models, and customizations.

Projects
Datasets

Load data, prepare data, and manage datasets.

Datasets
Models

Create, update, and manage models.

Models

References#

Entity Fields Reference

View the available fields for each entity that can be managed using the NeMo Entity Store.

Entity Fields Reference
NeMo Entity Store API Reference

Review the NeMo Entity Store API reference.

Entity Store API