(in this example the tag is created from GitHub; alternatively, you could just do the tag manually by checking out the release branch locally--remember to pull!!--and issuing the tag from local machine). -Encouraging in upstream to mark it as a non-production release (in the github screen). -Encouraging to use the "alpha" version policy of KF in the beginning of the release markdown (see previous pre-releases). +- encouraging to use the "alpha" version policy of KF in the beginning of the release markdown (see previous releases). It is helpful to prefix this in the release notes: diff --git a/api/openapi/catalog.yaml b/api/openapi/catalog.yaml index d4693c0dbb..6479d1012f 100644 --- a/api/openapi/catalog.yaml +++ b/api/openapi/catalog.yaml @@ -10,6 +10,32 @@ servers: - url: "https://localhost:8080" - url: "http://localhost:8080" paths: + /api/model_catalog/v1alpha1/labels: + summary: Path used to get the list of catalog labels. + description: >- + The REST endpoint/path used to list zero or more `CatalogLabel` entities. + get: + summary: List All CatalogLabels + tags: + - ModelCatalogService + parameters: + - $ref: "#/components/parameters/pageSize" + - $ref: "#/components/parameters/labelOrderBy" + - $ref: "#/components/parameters/sortOrder" + - $ref: "#/components/parameters/nextPageToken" + responses: + "200": + $ref: "#/components/responses/CatalogLabelListResponse" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: findLabels + description: Gets a list of all `CatalogLabel` entities. /api/model_catalog/v1alpha1/models: description: >- The REST endpoint/path used to list zero or more `CatalogModel` entities from all `CatalogSources`. @@ -20,20 +46,63 @@ paths: parameters: - name: source description: |- - Filter models by source. This parameter is currently required and - may only be specified once. + Filter models by source. Multiple values can be separated by commas + to filter by multiple sources (OR logic). For example: + ?source=huggingface,local will return models from either + huggingface OR local sources. schema: - type: string + type: array + items: + type: string + style: form + explode: true in: query - required: true + required: false - name: q description: Free-form keyword search used to filter the response. schema: type: string in: query required: false + - name: sourceLabel + description: |- + Filter models by the label associated with the source. Multiple + values can be separated by commas. If one of the values is the + string `null`, then models from every source without a label will + be returned. + schema: + type: array + items: + type: string + in: query + required: false + - $ref: "#/components/parameters/filterQuery" - $ref: "#/components/parameters/pageSize" - - $ref: "#/components/parameters/orderBy" + - name: orderBy + style: form + explode: true + examples: + orderBy: + value: ID + description: |- + Specifies the order by criteria for listing entities. + + Supported values are: + - CREATE_TIME + - LAST_UPDATE_TIME + - ID + - NAME + - ACCURACY + + The `ACCURACY` sort will sort by the `overall_average` property in any linked metrics artifact. + + In addition, models can be sorted by properties. For example: + - `provider.string_value` sorts by provider name + - `artifacts.ifeval.double_value` sorts by the min/max value a property called ifeval across all associated artifacts + schema: + $ref: "#/components/schemas/OrderByField" + in: query + required: false - $ref: "#/components/parameters/sortOrder" - $ref: "#/components/parameters/nextPageToken" responses: @@ -48,6 +117,22 @@ paths: "500": $ref: "#/components/responses/InternalServerError" operationId: findModels + /api/model_catalog/v1alpha1/models/filter_options: + description: Lists options for `filterQuery` when listing models. + get: + summary: Lists fields and available options that can be used in `filterQuery` on the list models endpoint. + tags: + - ModelCatalogService + responses: + "200": + $ref: "#/components/responses/FilterOptionsResponse" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: findModelsFilterOptions /api/model_catalog/v1alpha1/sources: summary: Path used to get the list of catalog sources. description: >- @@ -107,14 +192,14 @@ paths: required: true /api/model_catalog/v1alpha1/sources/{source_id}/models/{model_name}/artifacts: description: >- - The REST endpoint/path used to list `CatalogModelArtifacts`. + The REST endpoint/path used to list `CatalogArtifacts`. get: - summary: List CatalogModelArtifacts. + summary: List CatalogArtifacts. tags: - ModelCatalogService responses: "200": - $ref: "#/components/responses/CatalogModelArtifactListResponse" + $ref: "#/components/responses/CatalogArtifactListResponse" "401": $ref: "#/components/responses/Unauthorized" "404": @@ -135,16 +220,20 @@ paths: type: string in: path required: true + - $ref: "#/components/parameters/artifactType" + - $ref: "#/components/parameters/artifact_type" + - $ref: "#/components/parameters/artifactFilterQuery" + - $ref: "#/components/parameters/pageSize" + - $ref: "#/components/parameters/artifactOrderBy" + - $ref: "#/components/parameters/sortOrder" + - $ref: "#/components/parameters/nextPageToken" components: schemas: ArtifactTypeQueryParam: description: Supported artifact types for querying. enum: - model-artifact - - doc-artifact - - dataset-artifact - - metric - - parameter + - metrics-artifact type: string BaseModel: type: object @@ -202,6 +291,35 @@ components: type: object additionalProperties: $ref: "#/components/schemas/MetadataValue" + BaseResource: + allOf: + - type: object + properties: + customProperties: + description: User provided custom properties which are not defined by its type. + type: object + additionalProperties: + $ref: "#/components/schemas/MetadataValue" + description: + description: |- + An optional description about the resource. + type: string + externalId: + description: |- + The external id that come from the clients’ system. This field is optional. + If set, it must be unique among all resources within a database instance. + type: string + name: + description: |- + The client provided name of the artifact. This field is optional. If set, + it must be unique among all the artifacts of the same artifact type within + a database instance and cannot be changed once set. + type: string + id: + format: int64 + description: The unique server generated id of the resource. + type: string + - $ref: "#/components/schemas/BaseResourceDates" BaseResourceDates: description: Common timestamp fields for resources type: object @@ -234,6 +352,83 @@ components: format: int32 description: Number of items in result list. type: integer + CatalogArtifact: + description: A single artifact in the catalog API. + oneOf: + - $ref: "#/components/schemas/CatalogModelArtifact" + - $ref: "#/components/schemas/CatalogMetricsArtifact" + discriminator: + propertyName: artifactType + mapping: + model-artifact: "#/components/schemas/CatalogModelArtifact" + metrics-artifact: "#/components/schemas/CatalogMetricsArtifact" + CatalogArtifactList: + description: List of CatalogModel entities. + allOf: + - type: object + properties: + items: + description: Array of `CatalogArtifact` entities. + type: array + items: + $ref: "#/components/schemas/CatalogArtifact" + required: + - items + - $ref: "#/components/schemas/BaseResourceList" + CatalogLabel: + description: A catalog label. Labels are used to categorize catalog sources. Represented as a flexible map of string key-value pairs with a required 'name' field. + type: object + required: + - name + properties: + name: + type: string + nullable: true + description: The unique name identifier for the label. + displayName: + type: string + description: An optional human-readable name to show in place of `name`. + additionalProperties: + type: string + example: + name: huggingface + displayName: HuggingFace Hub + description: HuggingFace models with full support and legal indemnification. + CatalogLabelList: + description: List of CatalogLabel entities. + allOf: + - type: object + properties: + items: + description: Array of `CatalogLabel` entities. + type: array + items: + $ref: "#/components/schemas/CatalogLabel" + required: + - items + - $ref: "#/components/schemas/BaseResourceList" + CatalogMetricsArtifact: + description: A metadata Artifact Entity. + allOf: + - type: object + required: + - artifactType + - metricsType + properties: + artifactType: + type: string + default: metrics-artifact + metricsType: + type: string + enum: + - performance-metrics + - accuracy-metrics + customProperties: + description: User provided custom properties which are not defined by its type. + type: object + additionalProperties: + $ref: "#/components/schemas/MetadataValue" + - $ref: "#/components/schemas/BaseResource" CatalogModel: description: A model in the model catalog. allOf: @@ -248,38 +443,29 @@ components: source_id: type: string description: ID of the source this model belongs to. - - $ref: "#/components/schemas/BaseResourceDates" - $ref: "#/components/schemas/BaseModel" + - $ref: "#/components/schemas/BaseResource" CatalogModelArtifact: - description: A single artifact for a catalog model. + description: A Catalog Model Artifact Entity. allOf: - type: object required: + - artifactType - uri properties: + artifactType: + type: string + default: model-artifact uri: type: string format: uri - description: URI where the artifact can be retrieved. + description: URI where the model can be retrieved. customProperties: description: User provided custom properties which are not defined by its type. type: object additionalProperties: $ref: "#/components/schemas/MetadataValue" - - $ref: "#/components/schemas/BaseResourceDates" - CatalogModelArtifactList: - description: List of CatalogModel entities. - allOf: - - type: object - properties: - items: - description: Array of `CatalogModelArtifact` entities. - type: array - items: - $ref: "#/components/schemas/CatalogModelArtifact" - required: - - items - - $ref: "#/components/schemas/BaseResourceList" + - $ref: "#/components/schemas/BaseResource" CatalogModelList: description: List of CatalogModel entities. allOf: @@ -298,6 +484,7 @@ components: required: - id - name + - labels type: object properties: id: @@ -310,6 +497,32 @@ components: description: Whether the catalog source is enabled. type: boolean default: true + labels: + description: Labels for the catalog source. + type: array + items: + type: string + includedModels: + description: |- + Optional allow-list of models that are eligible for this source. Entries can be + exact model names or patterns that use `*` as a wildcard. When provided, only + models matching at least one pattern are considered. + + Pattern matching is case-insensitive, so `Granite/*` will match `granite/model`, + `Granite/model`, and `GRANITE/model`. + type: array + items: + type: string + excludedModels: + description: |- + Optional block-list of models that should be removed from the catalog even if + they match `includedModels`. Patterns support the `*` wildcard. + + Pattern matching is case-insensitive, so `*-beta` will match `Model-Beta`, + `model-beta`, and `MODEL-BETA`. + type: array + items: + type: string CatalogSourceList: description: List of CatalogSource entities. allOf: @@ -334,6 +547,42 @@ components: message: description: Error message type: string + FilterOption: + type: object + required: + - type + properties: + type: + type: string + description: The data type of the filter option + enum: + - string + - number + values: + type: array + description: Known values of the property for string types with a small number of possible options. + items: {} + range: + $ref: "#/components/schemas/FilterOptionRange" + FilterOptionRange: + type: object + description: Min and max values for number types. + properties: + min: + type: number + format: double + max: + type: number + format: double + FilterOptionsList: + description: List of FilterOptions + type: object + properties: + filters: + type: object + description: A single filter option. + additionalProperties: + $ref: "#/components/schemas/FilterOption" MetadataBoolValue: description: A bool property value. type: object @@ -442,7 +691,8 @@ components: string_value: my_value metadataType: MetadataStringValue OrderByField: - description: Supported fields for ordering result entities. + description: |- + Supported fields for ordering result entities. enum: - CREATE_TIME - LAST_UPDATE_TIME @@ -462,12 +712,18 @@ components: schema: $ref: "#/components/schemas/Error" description: Bad Request parameters - CatalogModelArtifactListResponse: + CatalogArtifactListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/CatalogArtifactList" + description: A response containing a list of CatalogArtifact entities. + CatalogLabelListResponse: content: application/json: schema: - $ref: "#/components/schemas/CatalogModelArtifactList" - description: A response containing a list of CatalogModelArtifact entities. + $ref: "#/components/schemas/CatalogLabelList" + description: A response containing a list of CatalogLabel entities. CatalogModelListResponse: content: application/json: @@ -498,6 +754,12 @@ components: schema: $ref: "#/components/schemas/Error" description: Conflict with current state of target resource + FilterOptionsResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/FilterOptionsList" + description: A response containing options for a `filterQuery` parameter. InternalServerError: content: application/json: @@ -529,6 +791,80 @@ components: $ref: "#/components/schemas/Error" description: Unprocessable Entity error parameters: + filterQuery: + examples: + filterQuery: + value: "name='my-model' AND state='LIVE'" + name: filterQuery + description: | + A SQL-like query string to filter the list of entities. The query supports rich filtering capabilities with automatic type inference. + + **Supported Operators:** + - Comparison: `=`, `!=`, `<>`, `>`, `<`, `>=`, `<=` + - Pattern matching: `LIKE`, `ILIKE` (case-insensitive) + - Set membership: `IN` + - Logical: `AND`, `OR` + - Grouping: `()` for complex expressions + + **Data Types:** + - Strings: `"value"` or `'value'` + - Numbers: `42`, `3.14`, `1e-5` + - Booleans: `true`, `false` (case-insensitive) + + **Property Access:** + - Standard properties: `name`, `id`, `state`, `createTimeSinceEpoch` + - Custom properties: Any user-defined property name + - Escaped properties: Use backticks for special characters: `` `custom-property` `` + - Type-specific access: `property.string_value`, `property.double_value`, `property.int_value`, `property.bool_value` + + **Examples:** + - Basic: `name = "my-model"` + - Comparison: `accuracy > 0.95` + - Pattern: `name LIKE "%tensorflow%"` + - Complex: `(name = "model-a" OR name = "model-b") AND state = "LIVE"` + - Custom property: `framework.string_value = "pytorch"` + - Escaped property: `` `mlflow.source.type` = "notebook" `` + schema: + type: string + in: query + required: false + artifactFilterQuery: + examples: + artifactFilterQuery: + value: "name='my-artifact' AND uri LIKE '%s3%'" + name: filterQuery + description: | + A SQL-like query string to filter catalog artifacts. The query supports rich filtering capabilities with automatic type inference. + + **Supported Operators:** + - Comparison: `=`, `!=`, `<>`, `>`, `<`, `>=`, `<=` + - Pattern matching: `LIKE`, `ILIKE` (case-insensitive) + - Set membership: `IN` + - Logical: `AND`, `OR` + - Grouping: `()` for complex expressions + + **Data Types:** + - Strings: `"value"` or `'value'` + - Numbers: `42`, `3.14`, `1e-5` + - Booleans: `true`, `false` (case-insensitive) + + **Property Access (Artifacts):** + - Standard properties: `name`, `id`, `uri`, `artifactType`, `createTimeSinceEpoch` + - Custom properties: Any user-defined property name in `customProperties` + - Escaped properties: Use backticks for special characters: `` `custom-property` `` + - Type-specific access: `property.string_value`, `property.double_value`, `property.int_value`, `property.bool_value` + + **Examples:** + - Basic: `name = "my-artifact"` + - Comparison: `ttft_mean > 90` + - Pattern: `uri LIKE "%s3.amazonaws.com%"` + - Complex: `(artifactType = "model-artifact" OR artifactType = "metrics-artifact") AND name LIKE "%pytorch%"` + - Custom property: `format.string_value = "pytorch"` + - Escaped property: `` `custom-key` = "value" `` + schema: + type: string + in: query + required: false orderBy: style: form explode: true @@ -541,6 +877,103 @@ components: $ref: "#/components/schemas/OrderByField" in: query required: false + artifactOrderBy: + style: form + explode: true + examples: + standardField: + value: ID + summary: Order by standard field + customPropertyDouble: + value: mmlu.double_value + summary: Order by custom double property + customPropertyString: + value: framework_type.string_value + summary: Order by custom string property + customPropertyInt: + value: hardware_count.int_value + summary: Order by custom integer property + name: orderBy + description: | + Specifies the order by criteria for listing artifacts. + + **Standard Fields:** + - `ID` - Order by artifact ID + - `NAME` - Order by artifact name + - `CREATE_TIME` - Order by creation timestamp + - `LAST_UPDATE_TIME` - Order by last update timestamp + + **Custom Property Ordering:** + + Artifacts can be ordered by custom properties using the format: `
- {configError?.message || - namespacesLoadError?.message || - initializationError?.message || - 'Unknown error occurred during startup'} -
-Logging out and logging back in may solve the issue
-
+
+
+
+
+
+
+
+
+
+
);
}
diff --git a/clients/ui/frontend/src/app/AppRoutes.tsx b/clients/ui/frontend/src/app/AppRoutes.tsx
index 3ededddb8e..bbd606d434 100644
--- a/clients/ui/frontend/src/app/AppRoutes.tsx
+++ b/clients/ui/frontend/src/app/AppRoutes.tsx
@@ -6,19 +6,36 @@ import { NavDataItem } from '~/app/standalone/types';
import ModelRegistrySettingsRoutes from './pages/settings/ModelRegistrySettingsRoutes';
import ModelRegistryRoutes from './pages/modelRegistry/ModelRegistryRoutes';
import ModelCatalogRoutes from './pages/modelCatalog/ModelCatalogRoutes';
+import ModelCatalogSettingsRoutes from './pages/modelCatalogSettings/ModelCatalogSettingsRoutes';
+import { modelCatalogUrl } from './routes/modelCatalog/catalogModel';
+import {
+ catalogSettingsUrl,
+ CATALOG_SETTINGS_PAGE_TITLE,
+} from './routes/modelCatalogSettings/modelCatalogSettings';
+import { modelRegistryUrl } from './pages/modelRegistry/screens/routeUtils';
import useUser from './hooks/useUser';
export const useAdminSettings = (): NavDataItem[] => {
const { clusterAdmin } = useUser();
+ const { config } = useModularArchContext();
+ const { deploymentMode } = config;
+ const isStandalone = deploymentMode === DeploymentMode.Standalone;
+ const isFederated = deploymentMode === DeploymentMode.Federated;
if (!clusterAdmin) {
return [];
}
+ const settingsChildren = [{ label: 'Model Registry', path: '/model-registry-settings' }];
+ // Only show Model Catalog Settings in Standalone or Federated mode
+ if (isStandalone || isFederated) {
+ settingsChildren.push({ label: CATALOG_SETTINGS_PAGE_TITLE, path: catalogSettingsUrl() });
+ }
+
return [
{
label: 'Settings',
- children: [{ label: 'Model Registry', path: '/model-registry-settings' }],
+ children: settingsChildren,
},
];
};
@@ -32,7 +49,7 @@ export const useNavData = (): NavDataItem[] => {
const baseNavItems = [
{
label: 'Model Registry',
- path: '/model-registry',
+ path: modelRegistryUrl(),
},
];
@@ -40,7 +57,7 @@ export const useNavData = (): NavDataItem[] => {
if (isStandalone || isFederated) {
baseNavItems.push({
label: 'Model Catalog',
- path: '/model-catalog',
+ path: modelCatalogUrl(),
});
}
@@ -56,10 +73,13 @@ const AppRoutes: React.FC = () => {
return (
+ {configError?.message || + namespacesLoadError?.message || + initializationError?.message || + 'Unknown error occurred during startup'} +
+Logging out and logging back in may solve the issue
+
- {model.description}
-
- ) : (
- model.description
- )}
- + The delay (in milliseconds) between sending a request and receiving the + first response. +
+-
+
+ {model.description}
+
+ );
+};
+
+export default ModelCatalogCardBody;
diff --git a/clients/ui/frontend/src/app/pages/modelCatalog/components/ModelCatalogFilters.tsx b/clients/ui/frontend/src/app/pages/modelCatalog/components/ModelCatalogFilters.tsx
new file mode 100644
index 0000000000..4f71eda4f9
--- /dev/null
+++ b/clients/ui/frontend/src/app/pages/modelCatalog/components/ModelCatalogFilters.tsx
@@ -0,0 +1,42 @@
+import * as React from 'react';
+import { Stack, Spinner, Alert } from '@patternfly/react-core';
+import { ModelCatalogContext } from '~/app/context/modelCatalog/ModelCatalogContext';
+import { ModelCatalogStringFilterKey } from '~/concepts/modelCatalog/const';
+import TaskFilter from './globalFilters/TaskFilter';
+import ProviderFilter from './globalFilters/ProviderFilter';
+import LicenseFilter from './globalFilters/LicenseFilter';
+import LanguageFilter from './globalFilters/LanguageFilter';
+
+const ModelCatalogFilters: React.FC = () => {
+ const { filterOptions, filterOptionsLoaded, filterOptionsLoadError } =
+ React.useContext(ModelCatalogContext);
+ const filters = filterOptions?.filters;
+ if (!filterOptionsLoaded) {
+ return
+ Range: {filters.range.min} - {filters.range.max}
+
+ No results found
+ )}
+ {visibleValues.map((checkbox) => (
+
-
- {catalogModels.isLoadingMore ? (
- <>
-
- Loading more catalog models...
-
-
- ) : (
-
- )}
-
-
- )}
-
- );
-};
-
-export default ModelCatalogPage;
diff --git a/clients/ui/frontend/src/app/pages/modelCatalog/screens/ModelCatalogSourceLabelBlocks.tsx b/clients/ui/frontend/src/app/pages/modelCatalog/screens/ModelCatalogSourceLabelBlocks.tsx
new file mode 100644
index 0000000000..e173b58480
--- /dev/null
+++ b/clients/ui/frontend/src/app/pages/modelCatalog/screens/ModelCatalogSourceLabelBlocks.tsx
@@ -0,0 +1,82 @@
+import { ToggleGroup, ToggleGroupItem } from '@patternfly/react-core';
+import React from 'react';
+import { ModelCatalogContext } from '~/app/context/modelCatalog/ModelCatalogContext';
+import { CategoryName, SourceLabel } from '~/app/modelCatalogTypes';
+import {
+ getUniqueSourceLabels,
+ filterEnabledCatalogSources,
+ hasSourcesWithoutLabels,
+} from '~/app/pages/modelCatalog/utils/modelCatalogUtils';
+
+type SourceLabelBlock = {
+ id: string;
+ label: string;
+ displayName: string;
+};
+
+const ModelCatalogSourceLabelBlocks: React.FC = () => {
+ const { catalogSources, updateSelectedSourceLabel, selectedSourceLabel } =
+ React.useContext(ModelCatalogContext);
+
+ const blocks: SourceLabelBlock[] = React.useMemo(() => {
+ if (!catalogSources) {
+ return [];
+ }
+
+ const enabledSources = filterEnabledCatalogSources(catalogSources);
+ const uniqueLabels = getUniqueSourceLabels(enabledSources);
+ const hasNoLabels = hasSourcesWithoutLabels(catalogSources);
+
+ const allBlock: SourceLabelBlock = {
+ id: 'all',
+ label: CategoryName.allModels,
+ displayName: CategoryName.allModels,
+ };
+
+ const labelBlocks: SourceLabelBlock[] = uniqueLabels.map((label) => ({
+ id: `label-${label}`,
+ label,
+ displayName: `${label} models`,
+ }));
+
+ const blocksToReturn: SourceLabelBlock[] = [allBlock, ...labelBlocks];
+
+ if (hasNoLabels) {
+ const noLabelsBlock: SourceLabelBlock = {
+ id: 'no-labels',
+ label: SourceLabel.other,
+ displayName: `${CategoryName.communityAndCustomModels} models`,
+ };
+ blocksToReturn.push(noLabelsBlock);
+ }
+
+ return blocksToReturn;
+ }, [catalogSources]);
+
+ if (!catalogSources) {
+ return null;
+ }
+
+ const handleToggleClick = (label: string) => {
+ updateSelectedSourceLabel(label);
+ };
+
+ return (
+