Skip to content

Commit

Permalink
[apache#5933] doc(catalog-model): Add docs for model management (apac…
Browse files Browse the repository at this point in the history
…he#6052)

### What changes were proposed in this pull request?

Add the docs for model management.

### Why are the changes needed?

This is part of work to support model management in Gravitino.

Fix: apache#5933 

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

N/A
  • Loading branch information
jerryshao authored Jan 7, 2025
1 parent 2019fcb commit 8e48de3
Show file tree
Hide file tree
Showing 15 changed files with 786 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ public void linkModelVersion(
NameIdentifier modelFullIdent = modelFullNameIdentifier(ident);
BaseResponse resp =
restClient.post(
formatModelVersionRequestPath(modelFullIdent),
formatModelVersionRequestPath(modelFullIdent) + "/versions",
req,
BaseResponse.class,
Collections.emptyMap(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,8 @@ public void testLinkModelVersion() throws JsonProcessingException {
String modelVersionPath =
withSlash(
GenericModelCatalog.formatModelVersionRequestPath(
NameIdentifier.of(METALAKE_NAME, CATALOG_NAME, "schema1", "model1")));
NameIdentifier.of(METALAKE_NAME, CATALOG_NAME, "schema1", "model1"))
+ "/versions");

ModelVersionLinkRequest request =
new ModelVersionLinkRequest(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ def link_model_version(
request.validate()

resp = self.rest_client.post(
f"{self._format_model_version_request_path(model_full_ident)}",
f"{self._format_model_version_request_path(model_full_ident)}/versions",
request,
error_handler=MODEL_ERROR_HANDLER,
)
Expand Down
Binary file modified docs/assets/gravitino-model-arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/metadata-model.png
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ REST API and the Java SDK. You can use either to manage metadata. See
how to manage fileset metadata.
* [Manage messaging metadata using Gravitino](./manage-messaging-metadata-using-gravitino.md) to learn how to manage
messaging metadata.
* [Manage model metadata using Gravitino](./manage-model-metadata-using-gravitino.md) to learn how to manage
model metadata.

Also, you can find the complete REST API definition in
[Gravitino Open API](./api/rest/gravitino-rest-api),
Expand Down Expand Up @@ -88,6 +90,10 @@ Gravitino currently supports the following catalogs:

* [**Kafka catalog**](./kafka-catalog.md)

**Model catalogs:**

* [**Model catalog**](./model-catalog.md)

## Apache Gravitino playground

To experience Gravitino with other components easily, Gravitino provides a playground to run. It
Expand Down Expand Up @@ -119,6 +125,7 @@ Gravitino supports different catalogs to manage the metadata in different source
* [Hadoop catalog](./hadoop-catalog.md): a complete guide to using Gravitino to manage fileset
using Hadoop Compatible File System (HCFS).
* [Kafka catalog](./kafka-catalog.md): a complete guide to using Gravitino to manage Kafka topics metadata.
* [Model catalog](./model-catalog.md): a complete guide to using Gravitino to manage model metadata.

### Governance

Expand Down
2 changes: 1 addition & 1 deletion docs/kafka-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ One Kafka catalog corresponds to one Kafka cluster.

### Catalog properties

Besides the [common catalog properties](./gravitino-server-config.md#gravitino-catalog-properties-configuration), the Kafka catalog has the following properties:
Besides the [common catalog properties](./gravitino-server-config.md#apache-gravitino-catalog-properties-configuration), the Kafka catalog has the following properties:

| Property Name | Description | Default Value | Required | Since Version |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/manage-metalake-using-gravitino.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

This page introduces how to create, modify, view, and delete [metalakes](./glossary.md#metalake) by using Gravitino.

## Prerequsites
## Prerequisites

You have installed and launched Gravitino. For more details, see [Get started](./getting-started.md).

Expand Down
Loading

0 comments on commit 8e48de3

Please sign in to comment.