diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f00ae17fa1..211ee5ca65 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,7 +18,7 @@ - [ ] Automated tests are provided as part of the PR for major new functionalities; testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). - [ ] The developer has manually tested the changes and verified that the changes work. - [ ] Code changes follow the [kubeflow contribution guidelines](https://www.kubeflow.org/docs/about/contributing/). -- [ ] **For first time contributors**: Please reach out to the [Reviewers](https://github.com/kubeflow/model-registry/blob/main/OWNERS) to ensure all tests are being run, ensuring the label `ok-to-test` has been added to the PR. +- [ ] **For first time contributors**: Please reach out to the [Reviewers](https://github.com/kubeflow/hub/blob/main/OWNERS) to ensure all tests are being run, ensuring the label `ok-to-test` has been added to the PR. If you have UI changes diff --git a/.github/workflows/first-time-contributor-pr.yml b/.github/workflows/first-time-contributor-pr.yml index 3c54406f98..a491215f1b 100644 --- a/.github/workflows/first-time-contributor-pr.yml +++ b/.github/workflows/first-time-contributor-pr.yml @@ -2,7 +2,7 @@ name: Welcome first-time contributors (Beta2) on: pull_request: - types: + types: - opened - synchronize - reopened @@ -33,16 +33,16 @@ jobs: python3 << 'EOF' import yaml import os - + with open('OWNERS', 'r') as f: data = yaml.safe_load(f) - + approvers = data.get('approvers', []) result = ' '.join([f'@{approver}' for approver in approvers]) - + with open(os.environ['GITHUB_OUTPUT'], 'a') as f: f.write(f'approvers={result}\n') - + print(f'Extracted approvers: {result}') EOF - name: Log approvers @@ -55,11 +55,11 @@ jobs: continue-on-error: true with: issue_message: | - 🎉 **Welcome to the Kubeflow Model Registry!** 🎉 + 🎉 **Welcome to the Kubeflow Hub!** 🎉 Thanks for opening your first issue! We're happy to have you as part of our community 🚀 **Here's what happens next:** - - If you'd like to contribute to this issue, check out our [Contributing Guide](https://github.com/kubeflow/model-registry/blob/main/CONTRIBUTING.md) for repo-specific guidelines and the [Kubeflow Contributor Guide](https://www.kubeflow.org/docs/about/contributing/) for general community standards + - If you'd like to contribute to this issue, check out our [Contributing Guide](https://github.com/kubeflow/hub/blob/main/CONTRIBUTING.md) for repo-specific guidelines and the [Kubeflow Contributor Guide](https://www.kubeflow.org/docs/about/contributing/) for general community standards - Our team will review your issue soon! **Join the community:** @@ -69,11 +69,11 @@ jobs: Feel free to ask questions in the comments if you need any help or clarification! Thanks again for contributing to Kubeflow! 🙏 pr_message: | - 🎉 **Welcome to the Kubeflow Model Registry!** 🎉 + 🎉 **Welcome to the Kubeflow Hub!** 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 **Here's what happens next:** - - If you haven't already, please check out our [Contributing Guide](https://github.com/kubeflow/model-registry/blob/main/CONTRIBUTING.md) for repo-specific guidelines and the [Kubeflow Contributor Guide](https://www.kubeflow.org/docs/about/contributing/) for general community standards + - If you haven't already, please check out our [Contributing Guide](https://github.com/kubeflow/hub/blob/main/CONTRIBUTING.md) for repo-specific guidelines and the [Kubeflow Contributor Guide](https://www.kubeflow.org/docs/about/contributing/) for general community standards - Our team will review your PR soon! **Join the community:** diff --git a/ADOPTERS.md b/ADOPTERS.md index 51979bbc5a..feb26d38af 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -1,6 +1,6 @@ -# Adopters of Kubeflow Model Registry +# Adopters of Kubeflow Hub -Below are the adopters of the Model Registry project. If you are using Model Registry in your organization, please add your name to the list by submitting a pull request: this will help foster the Kubeflow community. Kindly ensure the list remains in alphabetical order. +Below are the adopters of Kubeflow Hub (formerly known as Model Registry). If you are using this project in your organization, please add your name to the list by submitting a pull request: this will help foster the Kubeflow community. Kindly ensure the list remains in alphabetical order. If you are using other Kubeflow components, consider adding your name as well to the overall [Kubeflow Community Adopters file](https://github.com/kubeflow/community/blob/master/ADOPTERS.md). | Organization | Contact (GitHub User Name) | Environment | Description of Use | diff --git a/AGENTS.md b/AGENTS.md index 4d65833b7f..0ee1a07a5e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,4 +1,4 @@ -# AGENTS.md — Model Registry +# AGENTS.md — Kubeflow Hub ## Who This Is For @@ -312,7 +312,7 @@ The following directories contain auto-generated code. Modify the sources and re - Do not push secrets, credentials, or modify git config - Run `go mod tidy` if you changed dependencies - Keep commit messages brief -- Follow the Conventional Commit specification (e.g. `feat(catalog): `, `fix: some bug`) +- Follow the Conventional Commit specification (e.g. `feat(catalog): `, `fix: some bug`) ## Core Development Principles diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7dc71b48d1..23c8a9aaac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Kubeflow Contributor Guide -Welcome to the Kubeflow Model Registry project! We'd love to accept your patches and -contributions to this project. Please read the +Welcome to the Kubeflow Hub project! We'd love to accept your patches and +contributions to this project. Please read the [contributor's guide in our docs](https://www.kubeflow.org/docs/about/contributing/). The contributor's guide: @@ -10,7 +10,7 @@ The contributor's guide: * like explained in [this guide](https://wiki.linuxfoundation.org/dco), or [this example](https://github.com/kubeflow/community/tree/master/dco-signoff-hook#signing-off-commits) * references the [Code of Conduct](https://www.kubeflow.org/docs/about/contributing/#follow-the-code-of-conduct) * helps you get started with your first contribution to Kubeflow - * like how to identify [good-first-issue](https://github.com/kubeflow/model-registry/labels/good%20first%20issue) tickets + * like how to identify [good-first-issue](https://github.com/kubeflow/hub/labels/good%20first%20issue) tickets * and [describes](https://www.kubeflow.org/docs/about/contributing/#owners-files-and-pr-workflow) the pull request and review workflow in detail, including the OWNERS files and automated workflow tool @@ -18,11 +18,11 @@ The [Kubeflow Community calendar](https://www.kubeflow.org/docs/about/community/
-The remainder of this document focuses on technical aspects while contributing to the Model Registry project specifically. +The remainder of this document focuses on technical aspects while contributing to the Hub project specifically. -The [Model Registry documentation](https://github.com/kubeflow/model-registry?tab=readme-ov-file#documentation-links) provides details about: what is a Model Registry, how to Install, logical model Concepts, how the MR python client works, Tutorials, FAQs and most importantly the [Technical References](https://github.com/kubeflow/model-registry?tab=readme-ov-file#documentation-links:~:text=FAQs-,Development,-introduction%20to%20local)! +The [Kubeflow Hub documentation](https://github.com/kubeflow/hub?tab=readme-ov-file#documentation-links) provides details about: what is a Model Registry, how to Install, logical model Concepts, how the MR python client works, Tutorials, FAQs and most importantly the [Technical References](https://github.com/kubeflow/hub?tab=readme-ov-file#documentation-links:~:text=FAQs-,Development,-introduction%20to%20local)! -# Contributing to Model Registry using Apple-silicon/ARM-based computers +# Contributing to Hub using Apple-silicon/ARM-based computers Some limitations apply when developing on this project, specifically using Apple-silicon and Mac OSX. The content from this guide might also be applicable in part for general ARM-based developers/users, beyond Mac OSX. @@ -30,7 +30,7 @@ The content from this guide might also be applicable in part for general ARM-bas ## Consider installing coreutils While we strived to keep the repository scripts cross-compatible with GNU and BSD utilities, you might want to consider installing the `coreutils` from Homebrew, [following these instructions](https://formulae.brew.sh/formula/coreutils). -You will need to ensure the gnubin directory is added to your shell path. +You will need to ensure the gnubin directory is added to your shell path. ## Makefile @@ -72,9 +72,9 @@ to your PATH from your bashrc like: and now you can substitute `gmake` every time the make command is mentioned in guides (or perform the path management per the caveat). -## Local kubernetes deployment of Model Registry +## Local kubernetes deployment of Hub -To test the Model Registry locally without mocking the k8s calls, the Model Registry backend can be deployed using Kind. +To test the Hub locally without mocking the k8s calls, the backend can be deployed using Kind. ### Prerequisites @@ -94,11 +94,11 @@ Create a Kind cluster with the following command: kind create cluster ``` -and then follow the steps from the [Installation guide](https://www.kubeflow.org/docs/components/model-registry/installation/#standalone-installation) on the Kubeflow website, to set up the port-forwarding and deploy the Model Registry on the cluster. +and then follow the steps from the [Installation guide](https://www.kubeflow.org/docs/components/model-registry/installation/#standalone-installation) on the Kubeflow website, to set up the port-forwarding and deploy Hub on the cluster. ### Ingress guide -Follow the [Ingress guide](docs/mr_kind_deploy_ingress.md) to set up the Ingress controller and deploy the Model Registry on the cluster. +Follow the [Ingress guide](docs/mr_kind_deploy_ingress.md) to set up the Ingress controller and deploy Hub on the cluster. ## Docker engine @@ -280,5 +280,5 @@ Solution: - Use `export TESTCONTAINERS_RYUK_DISABLED=true` to disable Ryuk entirely; the tests are configured to close all container resources, but we do not recommend this option For more information: -- section [Docker engine](https://github.com/kubeflow/model-registry/blob/main/CONTRIBUTING.md#docker-engine) in this document +- section [Docker engine](https://github.com/kubeflow/hub/blob/main/CONTRIBUTING.md#docker-engine) in this document - https://pypi.org/project/testcontainers/#:~:text=the%20database%20version.-,Configuration,-Env%20Variable diff --git a/Makefile b/Makefile index 8ec34d88a8..f9fa4ff666 100644 --- a/Makefile +++ b/Makefile @@ -144,7 +144,7 @@ endif .PHONY: vet vet: @echo "Running go vet on all packages..." - @${GO} vet $$(${GO} list ./... | grep -vF github.com/kubeflow/model-registry/internal/db/filter) && \ + @${GO} vet $$(${GO} list ./... | grep -vF github.com/kubeflow/hub/internal/db/filter) && \ echo "Checking filter package (parser.go excluded due to participle struct tags)..." && \ cd internal/db/filter && ${GO} build -o /dev/null . 2>&1 | grep -E "vet:|error:" || echo "✓ Filter package builds successfully" @@ -308,7 +308,7 @@ image/build: ${DOCKER} build ${BUILD_PATH} -f ${DOCKERFILE} -t ${IMG}:$(IMG_VERSION) $(ARGS) # build docker image using buildx -# PLATFORMS defines the target platforms for the model registry image be built to provide support to multiple +# PLATFORMS defines the target platforms for the image be built to provide support to multiple # architectures. (i.e. make docker-buildx). To use this option you need to: # - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/ # - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/ diff --git a/README.md b/README.md index 38894b247f..4ed6ea21b4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Model Registry +# Kubeflow Hub -![build checks status](https://github.com/kubeflow/model-registry/actions/workflows/build.yml/badge.svg?branch=main) -[![codecov](https://codecov.io/github/kubeflow/model-registry/graph/badge.svg?token=61URLQA3VS)](https://codecov.io/github/kubeflow/model-registry) +![build checks status](https://github.com/kubeflow/hub/actions/workflows/build.yml/badge.svg?branch=main) +[![codecov](https://codecov.io/github/kubeflow/hub/graph/badge.svg?token=61URLQA3VS)](https://codecov.io/github/kubeflow/hub) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubeflow%2Fmodel-registry.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubeflow%2Fmodel-registry?ref=badge_shield&issueType=license) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9937/badge)](https://www.bestpractices.dev/projects/9937) -[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/kubeflow/model-registry/badge)](https://scorecard.dev/viewer/?uri=github.com/kubeflow/model-registry) +[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/kubeflow/hub/badge)](https://scorecard.dev/viewer/?uri=github.com/kubeflow/hub) -Model registry provides a central repository for model developers to store and manage models, versions, and artifacts metadata. +Kubeflow Hub (formerly known as Model Registry) provides a central repository for model developers to store and manage models, versions, and artifacts metadata. ## Red Hat's Pledge - Red Hat drives the project's development through Open Source principles, ensuring transparency, sustainability, and community ownership. @@ -14,7 +14,7 @@ Model registry provides a central repository for model developers to store and m > **Alpha** > -> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/model-registry) about the usability of the feature. +> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/hub) about the usability of the feature. ## Documentation links: @@ -39,10 +39,10 @@ Model registry provides a central repository for model developers to store and m - [contributing](./CONTRIBUTING.md) - [Kubeflow community and the Model Registry working group](https://www.kubeflow.org/docs/about/community/) - REST API - - [OpenAPI definition](https://editor.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/model-registry/main/api/openapi/model-registry.yaml) - - [playground](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/model-registry/main/api/openapi/model-registry.yaml) - - [license scanning](https://github.com/kubeflow/model-registry/issues/323) - - [monitoring image quality](https://github.com/kubeflow/model-registry/issues/327) + - [OpenAPI definition](https://editor.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/hub/main/api/openapi/model-registry.yaml) + - [playground](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/hub/main/api/openapi/model-registry.yaml) + - [license scanning](https://github.com/kubeflow/hub/issues/323) + - [monitoring image quality](https://github.com/kubeflow/hub/issues/327) 8. [UI](clients/ui/README.md) ## Pre-requisites: @@ -54,7 +54,7 @@ Model registry provides a central repository for model developers to store and m ## OpenAPI Proxy Server -The model registry proxy server implementation follows a contract-first approach, where the contract is identified by [model-registry.yaml](api/openapi/model-registry.yaml) OpenAPI specification. +The Hub backend server follows a contract-first approach, where the contract is identified by [model-registry.yaml](api/openapi/model-registry.yaml) OpenAPI specification. You can also easily display the latest OpenAPI contract for model-registry in a Swagger-like editor directly from the documentation site, [here](https://www.kubeflow.org/docs/components/model-registry/reference/rest-api/#swagger-ui). ### Starting the OpenAPI Proxy Server @@ -63,7 +63,7 @@ Run the following command to start the OpenAPI proxy server from source: ```shell make run/proxy ``` -The proxy service implements the OpenAPI defined in [model-registry.yaml](api/openapi/model-registry.yaml) to create a Model Registry specific REST API. +The backend service implements the OpenAPI defined in [model-registry.yaml](api/openapi/model-registry.yaml) to create a Model Registry specific REST API. ### Model registry logical model @@ -152,14 +152,14 @@ Where, ``, ``, and `` are the same as in the migrate comman And `` and `` are the local ip and port to use to expose the container's default `8080` listening port. The server listens on `localhost` by default, hence the `-n 0.0.0.0` option allows the server port to be exposed. -#### Running model registry +#### Running Kubeflow Hub > **NOTE:** Docker Compose or Podman Compose must be installed in your environment. There are two `docker-compose` files that make the startup easier: - `docker-compose.yaml` - Uses pre-built images from registry -- `docker-compose-local.yaml` - Builds model registry from source +- `docker-compose-local.yaml` - Builds Hub from source Both files support MySQL and PostgreSQL databases using profiles. @@ -171,7 +171,7 @@ The easiest way to run the services is using the provided Makefile targets: # Start with MySQL (using pre-built images) make compose/up -# Start with PostgreSQL (using pre-built images) +# Start with PostgreSQL (using pre-built images) make compose/up/postgres # Start with MySQL (builds from source) @@ -195,7 +195,7 @@ Alternatively, you can run the compose files directly: # Using pre-built images with MySQL docker-compose --profile mysql up -# Using pre-built images with PostgreSQL +# Using pre-built images with PostgreSQL DB_TYPE=postgres docker-compose --profile postgres up # Building from source with PostgreSQL @@ -206,7 +206,7 @@ The Makefile automatically detects whether to use `docker-compose`, `podman-comp ### Testing architecture -The following diagram illustrates testing strategy for the several components in Model Registry project: +The following diagram illustrates testing strategy for the several components in the Hub project: ![](/docs/Model%20Registry%20Testing%20areas.drawio.png) @@ -259,7 +259,7 @@ If you cannot access the CNCF Service Desk, ask one of your fellow Approvers for ## Tips ### Pull image rate limiting -Occasionally you may encounter an 'ImagePullBackOff' error when deploying the Model Registry manifests. See example below for the `model-registry-db` container. +Occasionally you may encounter an 'ImagePullBackOff' error when deploying the Hub project's manifests. See example below for the `model-registry-db` container. ``` Failed to pull image “mysql:8.3.0”: rpc error: code = Unknown desc = fetching target platform image selected from image index: reading manifest sha256:f9097d95a4ba5451fff79f4110ea6d750ac17ca08840f1190a73320b84ca4c62 in docker.io/library/mysql: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit diff --git a/RELEASE.md b/RELEASE.md index 11e0fa49a3..b03fd531d3 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,21 +1,21 @@ # Release Process -This document describes the Release process followed by this Kubeflow Model Registry component project, enacted by its Maintainers. +This document describes the Release process followed by this Kubeflow Hub component project, enacted by its Maintainers. # Principles -The Kubeflow Model Registry follows the [Github Release Workflow](https://github.com/kubeflow/model-registry/releases), and performs periodic releases in accordance with the Kubeflow Platform WG recommendations. +The Kubeflow Hub follows the [Github Release Workflow](https://github.com/kubeflow/hub/releases), and performs periodic releases in accordance with the Kubeflow Platform WG recommendations. -The Kubeflow Model Registry follows [Semantic Versioning](https://semver.org/): `MAJOR.MINOR.PATCH`. +The Kubeflow Hub follows [Semantic Versioning](https://semver.org/): `MAJOR.MINOR.PATCH`. -The Kubeflow Model Registry per governance of the Kubeflow Community, Kubeflow Platform WG, and KSC, releases as Alpha version, including the following statement: +The Kubeflow Hub per governance of the Kubeflow Community, Kubeflow Platform WG, and KSC, releases as Alpha version, including the following statement: ```md > **Alpha** -> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/model-registry/issues/new/choose) about the usability of the feature. +> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/hub/issues/new/choose) about the usability of the feature. ``` -The Release of the Kubeflow Model Registry provides: +The Release of the Kubeflow Hub provides: - a container image for the Backend; known as the "KF MR Go REST server" - a Python client to be used in a Jupyter notebook, programmatically, or that can be integrated in the Kubeflow SDK; known as the "MR py client" - an optional Model Registry Custom Storage Initializer container image for KServe; the "Model Registry CSI" @@ -31,14 +31,14 @@ Assuming the following remotes are setup locally: ``` origin git@github.com:/model-registry.git (fetch) origin git@github.com:/model-registry.git (push) -upstream git@github.com:kubeflow/model-registry.git (fetch) -upstream git@github.com:kubeflow/model-registry.git (push) +upstream git@github.com:kubeflow/hub.git (fetch) +upstream git@github.com:kubeflow/hub.git (push) ``` and for the rest of this instructions, the `` will be referred as `mr_maintainer`. Prerequisites: -- on main branch, the version indicated by the [pyproject.toml](https://github.com/kubeflow/model-registry/blob/d2312907025adbe83d3faafbecf1474824d055ed/clients/python/pyproject.toml#L3) and [metadadata](https://github.com/kubeflow/model-registry/blob/d2312907025adbe83d3faafbecf1474824d055ed/clients/python/src/model_registry/__init__.py#L3) of the Model Registry Python client is current (that is, is already valorized to the _target_ release number). +- on main branch, the version indicated by the [pyproject.toml](https://github.com/kubeflow/hub/blob/d2312907025adbe83d3faafbecf1474824d055ed/clients/python/pyproject.toml#L3) and [metadadata](https://github.com/kubeflow/hub/blob/d2312907025adbe83d3faafbecf1474824d055ed/clients/python/src/model_registry/__init__.py#L3) of the Model Registry Python client is current (that is, is already valorized to the _target_ release number). - the main branch is up-to-date, all the required work has been already merged. ``` @@ -54,7 +54,7 @@ TDATE=$(date "+%Y%m%d") ``` > [!NOTE] -> We no longer explicits the `-alpha` suffix (see [here](https://github.com/kubeflow/model-registry/issues/435#issuecomment-2384745910)). +> We no longer explicits the `-alpha` suffix (see [here](https://github.com/kubeflow/hub/issues/435#issuecomment-2384745910)). - create the release branch upstream @@ -87,15 +87,15 @@ git push --set-upstream origin mr_maintainer-$TDATE-upstreamSync - create PR ⚠️ targeting the _release branch_ ⚠️ specifically (title ~like: `chore: align manifest for 0.2.10`) - merge the PR (you can manually add the approved, lgtm labels) -- optional. if you create the tag from local git (see point below); await GHA complete that push Container images to docker.io or any other KF registry: https://github.com/kubeflow/model-registry/actions -- create [the Release from GitHub](https://github.com/kubeflow/model-registry/releases/new), ⚠️ select the _release branch_ ⚠️ , input the _new tag_
(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). +- optional. if you create the tag from local git (see point below); await GHA complete that push Container images to docker.io or any other KF registry: https://github.com/kubeflow/hub/actions +- create [the Release from GitHub](https://github.com/kubeflow/hub/releases/new), ⚠️ select the _release branch_ ⚠️ , input the _new tag_
(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 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: ```md > **Alpha** -> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/model-registry/issues/new/choose) about the usability of the feature. +> This Kubeflow component has alpha status with limited support. See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/hub/issues/new/choose) about the usability of the feature. ``` - release the MR Python client @@ -141,4 +141,5 @@ Please notice the OpenAPI spec in the Reference section is automatically updated See at the beginning "Prerequisites", to facilitate the next round, now it's the best time: - bump already MR py client to the next version, example PR -https://github.com/kubeflow/model-registry/pull/871 + +https://github.com/kubeflow/hub/pull/871 diff --git a/ROADMAP.md b/ROADMAP.md index 3ec3cb9025..70044ff338 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,20 +1,20 @@ -# Kubeflow Model Registry Roadmap +# Kubeflow Hub Roadmap ## Overview -The Kubeflow Model Registry project roadmap is tracked using [GitHub Milestones](https://github.com/kubeflow/model-registry/milestones), following the Kubeflow Release Team's request: this approach has been recommended in order to maintain a detailed view of all the items intended for upcoming Kubeflow releases, organized by "themes". The roadmap is continuously updated as we make progress towards a Kubeflow Release. +The Kubeflow Hub project roadmap is tracked using [GitHub Milestones](https://github.com/kubeflow/hub/milestones), following the Kubeflow Release Team's request: this approach has been recommended in order to maintain a detailed view of all the items intended for upcoming Kubeflow releases, organized by "themes". The roadmap is continuously updated as we make progress towards a Kubeflow Release. ## Current Roadmap -The current roadmap and upcoming features are tracked in our [GitHub Milestones](https://github.com/kubeflow/model-registry/milestones). Each milestone tracks specific or future Kubeflow release and contains the planned features, enhancements, and bug fixes. For each milestone, a GitHub Issue is typically attached serving as a Tracker record to provide additional details. +The current roadmap and upcoming features are tracked in our [GitHub Milestones](https://github.com/kubeflow/hub/milestones). Each milestone tracks specific or future Kubeflow release and contains the planned features, enhancements, and bug fixes. For each milestone, a GitHub Issue is typically attached serving as a Tracker record to provide additional details. ## Past Roadmaps - Model Registry in Kubeflow 1.10 - - [Milestone](https://github.com/kubeflow/model-registry/milestone/1) - - [Tracker for details](https://github.com/kubeflow/model-registry/issues/175) + - [Milestone](https://github.com/kubeflow/hub/milestone/1) + - [Tracker for details](https://github.com/kubeflow/hub/issues/175) - Model Registry in Kubeflow 1.9 - - [Tracker for details](https://github.com/kubeflow/model-registry/issues/3) + - [Tracker for details](https://github.com/kubeflow/hub/issues/3) ## See also diff --git a/SECURITY.md b/SECURITY.md index aa618dccff..f032ae6e19 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,11 +2,11 @@ ## Supported Versions -Kubeflow Model Registry versions are expressed as `vX.Y.Z`, where X is the major version, +Kubeflow Hub versions are expressed as `vX.Y.Z`, where X is the major version, Y is the minor version, and Z is the patch version, following the [Semantic Versioning](https://semver.org/) terminology. -The Kubeflow Model Registry project maintains release branches for the most recent two minor releases. +The Kubeflow Hub project maintains release branches for the most recent two minor releases. Applicable fixes, including security fixes, may be backported to those two release branches, depending on severity and feasibility. @@ -20,7 +20,7 @@ Kubeflow Open Source Community. All reports are thoroughly investigated by Kubef You can use the following ways to report security vulnerabilities privately: -- Using the Kubeflow Model Registry repository [GitHub Security Advisory](https://github.com/kubeflow/model-registry/security/advisories/new). +- Using the Kubeflow Hub repository [GitHub Security Advisory](https://github.com/kubeflow/hub/security/advisories/new). - Using our private Kubeflow Steering Committee mailing list: ksc@kubeflow.org. Please provide detailed information to help us understand and address the issue promptly. @@ -42,7 +42,7 @@ release notes and communicated through appropriate channels. ## Prevention Mechanisms -Kubeflow Model Registry employs several measures to prevent security issues: +Kubeflow Hub employs several measures to prevent security issues: **Code Reviews**: All code changes are reviewed by maintainers to ensure code quality and security. diff --git a/api/openapi/catalog.yaml b/api/openapi/catalog.yaml index 08a1dcb700..e181c18ecb 100644 --- a/api/openapi/catalog.yaml +++ b/api/openapi/catalog.yaml @@ -1,8 +1,8 @@ openapi: 3.0.3 info: - title: Model Catalog REST API + title: Catalog REST API + description: REST API for Kubeflow Hub Catalog version: v1alpha1 - description: REST API for Model Registry to create and manage ML model metadata license: name: Apache 2.0 url: "https://www.apache.org/licenses/LICENSE-2.0" diff --git a/api/openapi/src/catalog.yaml b/api/openapi/src/catalog.yaml index 91e8bdbb70..a80a14adce 100644 --- a/api/openapi/src/catalog.yaml +++ b/api/openapi/src/catalog.yaml @@ -1,8 +1,8 @@ openapi: 3.0.3 info: - title: Model Catalog REST API + title: Catalog REST API + description: REST API for Kubeflow Hub Catalog version: v1alpha1 - description: REST API for Model Registry to create and manage ML model metadata license: name: Apache 2.0 url: "https://www.apache.org/licenses/LICENSE-2.0" diff --git a/catalog/README.md b/catalog/README.md index 681e29284a..93259defe5 100644 --- a/catalog/README.md +++ b/catalog/README.md @@ -33,7 +33,7 @@ The catalog service operates as a **metadata aggregation layer** that: View the complete API specification: - [Swagger UI](https://www.kubeflow.org/docs/components/model-registry/reference/model-catalog-rest-api/#swagger-ui) -- [Swagger Playground](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/model-registry/main/api/openapi/catalog.yaml) +- [Swagger Playground](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/kubeflow/hub/main/api/openapi/catalog.yaml) ## Data Models @@ -540,4 +540,4 @@ The catalog service is designed to complement the main Model Registry service by - Unified metadata aggregation - Read-only access to distributed model catalogs -For complete Model Registry documentation, see the [main README](../README.md). +For complete Kubeflow Hub documentation, see the [main README](../README.md). diff --git a/catalog/clients/python/pyproject.toml b/catalog/clients/python/pyproject.toml index f675fccb85..fbb2b33078 100644 --- a/catalog/clients/python/pyproject.toml +++ b/catalog/clients/python/pyproject.toml @@ -2,17 +2,17 @@ name = "model-catalog" version = "0.1.0" description = "Client for Kubeflow Model Catalog" -authors = ["Kubeflow Model Registry Team"] +authors = ["Kubeflow Hub Team"] license = "Apache-2.0" readme = "README.md" -homepage = "https://github.com/kubeflow/model-registry" +homepage = "https://github.com/kubeflow/hub" packages = [ { include = "model_catalog", from = "src" }, { include = "catalog_openapi", from = "src" }, ] [tool.poetry.urls] -"Issues" = "https://github.com/kubeflow/model-registry/issues" +"Issues" = "https://github.com/kubeflow/hub/issues" [tool.poetry.dependencies] python = "^3.10" @@ -136,4 +136,3 @@ warn_redundant_casts = true warn_unused_ignores = true warn_no_return = true exclude = ["src/catalog_openapi/"] - diff --git a/catalog/internal/server/openapi/api.go b/catalog/internal/server/openapi/api.go index d83446efad..690cc99eab 100644 --- a/catalog/internal/server/openapi/api.go +++ b/catalog/internal/server/openapi/api.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/api_mcp_catalog_service.go b/catalog/internal/server/openapi/api_mcp_catalog_service.go index 6fc141dc56..0a1b704659 100644 --- a/catalog/internal/server/openapi/api_mcp_catalog_service.go +++ b/catalog/internal/server/openapi/api_mcp_catalog_service.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/api_model_catalog_service.go b/catalog/internal/server/openapi/api_model_catalog_service.go index e5ccb4eb25..f70181b3aa 100644 --- a/catalog/internal/server/openapi/api_model_catalog_service.go +++ b/catalog/internal/server/openapi/api_model_catalog_service.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/error.go b/catalog/internal/server/openapi/error.go index 23f4b70bae..04ecc73f8f 100644 --- a/catalog/internal/server/openapi/error.go +++ b/catalog/internal/server/openapi/error.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/helpers.go b/catalog/internal/server/openapi/helpers.go index 018a6a7475..232c5ebfb4 100644 --- a/catalog/internal/server/openapi/helpers.go +++ b/catalog/internal/server/openapi/helpers.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/impl.go b/catalog/internal/server/openapi/impl.go index 36a7634744..772785539f 100644 --- a/catalog/internal/server/openapi/impl.go +++ b/catalog/internal/server/openapi/impl.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/logger.go b/catalog/internal/server/openapi/logger.go index fb3ebe69d0..59de4c78cc 100644 --- a/catalog/internal/server/openapi/logger.go +++ b/catalog/internal/server/openapi/logger.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/internal/server/openapi/routers.go b/catalog/internal/server/openapi/routers.go index 8d5a657775..d88d837265 100644 --- a/catalog/internal/server/openapi/routers.go +++ b/catalog/internal/server/openapi/routers.go @@ -1,9 +1,9 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. /* - * Model Catalog REST API + * Catalog REST API * - * REST API for Model Registry to create and manage ML model metadata + * REST API for Kubeflow Hub Catalog * * API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/api_mcp_catalog_service.go b/catalog/pkg/openapi/api_mcp_catalog_service.go index 7f69e0dcea..84bbbc776a 100644 --- a/catalog/pkg/openapi/api_mcp_catalog_service.go +++ b/catalog/pkg/openapi/api_mcp_catalog_service.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/api_model_catalog_service.go b/catalog/pkg/openapi/api_model_catalog_service.go index 08f6246c50..2a9546240c 100644 --- a/catalog/pkg/openapi/api_model_catalog_service.go +++ b/catalog/pkg/openapi/api_model_catalog_service.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/client.go b/catalog/pkg/openapi/client.go index f243533402..e9600df0b3 100644 --- a/catalog/pkg/openapi/client.go +++ b/catalog/pkg/openapi/client.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ @@ -40,7 +40,7 @@ var ( queryDescape = strings.NewReplacer("%5B", "[", "%5D", "]") ) -// APIClient manages communication with the Model Catalog REST API API vv1alpha1 +// APIClient manages communication with the Catalog REST API API vv1alpha1 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration diff --git a/catalog/pkg/openapi/configuration.go b/catalog/pkg/openapi/configuration.go index f51dbfb7ff..c4779ed68d 100644 --- a/catalog/pkg/openapi/configuration.go +++ b/catalog/pkg/openapi/configuration.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_artifact_type_query_param.go b/catalog/pkg/openapi/model_artifact_type_query_param.go index 041c91f8e8..26b84e5b9b 100644 --- a/catalog/pkg/openapi/model_artifact_type_query_param.go +++ b/catalog/pkg/openapi/model_artifact_type_query_param.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_base_model.go b/catalog/pkg/openapi/model_base_model.go index 83f5e13dc0..c07c0e2c02 100644 --- a/catalog/pkg/openapi/model_base_model.go +++ b/catalog/pkg/openapi/model_base_model.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_base_resource.go b/catalog/pkg/openapi/model_base_resource.go index 43938ac14c..c00c1e2f7b 100644 --- a/catalog/pkg/openapi/model_base_resource.go +++ b/catalog/pkg/openapi/model_base_resource.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_base_resource_dates.go b/catalog/pkg/openapi/model_base_resource_dates.go index cd717ca091..21289d105c 100644 --- a/catalog/pkg/openapi/model_base_resource_dates.go +++ b/catalog/pkg/openapi/model_base_resource_dates.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_base_resource_list.go b/catalog/pkg/openapi/model_base_resource_list.go index ac240bbd30..7cdc7e6d00 100644 --- a/catalog/pkg/openapi/model_base_resource_list.go +++ b/catalog/pkg/openapi/model_base_resource_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_artifact.go b/catalog/pkg/openapi/model_catalog_artifact.go index cd61bc3907..e5d994059f 100644 --- a/catalog/pkg/openapi/model_catalog_artifact.go +++ b/catalog/pkg/openapi/model_catalog_artifact.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_artifact_list.go b/catalog/pkg/openapi/model_catalog_artifact_list.go index 8dd348d010..da0e3f7ebc 100644 --- a/catalog/pkg/openapi/model_catalog_artifact_list.go +++ b/catalog/pkg/openapi/model_catalog_artifact_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_asset_type.go b/catalog/pkg/openapi/model_catalog_asset_type.go index 2f884f74e9..bf1801629c 100644 --- a/catalog/pkg/openapi/model_catalog_asset_type.go +++ b/catalog/pkg/openapi/model_catalog_asset_type.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_label.go b/catalog/pkg/openapi/model_catalog_label.go index 95f2a6af54..a07af2b913 100644 --- a/catalog/pkg/openapi/model_catalog_label.go +++ b/catalog/pkg/openapi/model_catalog_label.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_label_list.go b/catalog/pkg/openapi/model_catalog_label_list.go index 4e1581e54b..486f388ce8 100644 --- a/catalog/pkg/openapi/model_catalog_label_list.go +++ b/catalog/pkg/openapi/model_catalog_label_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_metrics_artifact.go b/catalog/pkg/openapi/model_catalog_metrics_artifact.go index c4f254caf8..0685022325 100644 --- a/catalog/pkg/openapi/model_catalog_metrics_artifact.go +++ b/catalog/pkg/openapi/model_catalog_metrics_artifact.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_model.go b/catalog/pkg/openapi/model_catalog_model.go index 79ef66fe10..cf81f433f0 100644 --- a/catalog/pkg/openapi/model_catalog_model.go +++ b/catalog/pkg/openapi/model_catalog_model.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_model_artifact.go b/catalog/pkg/openapi/model_catalog_model_artifact.go index cf934793e9..e1cc1ed92a 100644 --- a/catalog/pkg/openapi/model_catalog_model_artifact.go +++ b/catalog/pkg/openapi/model_catalog_model_artifact.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_model_list.go b/catalog/pkg/openapi/model_catalog_model_list.go index a3a3543626..8dc1cf4bd4 100644 --- a/catalog/pkg/openapi/model_catalog_model_list.go +++ b/catalog/pkg/openapi/model_catalog_model_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_source.go b/catalog/pkg/openapi/model_catalog_source.go index 8f59a75585..4bf3453bc5 100644 --- a/catalog/pkg/openapi/model_catalog_source.go +++ b/catalog/pkg/openapi/model_catalog_source.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_source_list.go b/catalog/pkg/openapi/model_catalog_source_list.go index 9c51c934ea..03de96704e 100644 --- a/catalog/pkg/openapi/model_catalog_source_list.go +++ b/catalog/pkg/openapi/model_catalog_source_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_source_preview_response.go b/catalog/pkg/openapi/model_catalog_source_preview_response.go index 3a7e6645e9..7623cd35f5 100644 --- a/catalog/pkg/openapi/model_catalog_source_preview_response.go +++ b/catalog/pkg/openapi/model_catalog_source_preview_response.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_source_preview_response_all_of_summary.go b/catalog/pkg/openapi/model_catalog_source_preview_response_all_of_summary.go index e903cb82bf..5465ed200c 100644 --- a/catalog/pkg/openapi/model_catalog_source_preview_response_all_of_summary.go +++ b/catalog/pkg/openapi/model_catalog_source_preview_response_all_of_summary.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_catalog_source_status.go b/catalog/pkg/openapi/model_catalog_source_status.go index f995e30499..a874fcbc76 100644 --- a/catalog/pkg/openapi/model_catalog_source_status.go +++ b/catalog/pkg/openapi/model_catalog_source_status.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_error.go b/catalog/pkg/openapi/model_error.go index df6578b1f7..31d36aa8df 100644 --- a/catalog/pkg/openapi/model_error.go +++ b/catalog/pkg/openapi/model_error.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_field_filter.go b/catalog/pkg/openapi/model_field_filter.go index 370cfad264..3822997296 100644 --- a/catalog/pkg/openapi/model_field_filter.go +++ b/catalog/pkg/openapi/model_field_filter.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_filter_option.go b/catalog/pkg/openapi/model_filter_option.go index 7d8091c187..f45938af95 100644 --- a/catalog/pkg/openapi/model_filter_option.go +++ b/catalog/pkg/openapi/model_filter_option.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_filter_option_range.go b/catalog/pkg/openapi/model_filter_option_range.go index 8e69383b67..8d1460e39b 100644 --- a/catalog/pkg/openapi/model_filter_option_range.go +++ b/catalog/pkg/openapi/model_filter_option_range.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_filter_options_list.go b/catalog/pkg/openapi/model_filter_options_list.go index d30cfbf81e..7488910e0c 100644 --- a/catalog/pkg/openapi/model_filter_options_list.go +++ b/catalog/pkg/openapi/model_filter_options_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_artifact.go b/catalog/pkg/openapi/model_mcp_artifact.go index 9ec2b672b4..b9db9f1bb0 100644 --- a/catalog/pkg/openapi/model_mcp_artifact.go +++ b/catalog/pkg/openapi/model_mcp_artifact.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_config_map_key.go b/catalog/pkg/openapi/model_mcp_config_map_key.go index 259bf63ec0..4d80898fd6 100644 --- a/catalog/pkg/openapi/model_mcp_config_map_key.go +++ b/catalog/pkg/openapi/model_mcp_config_map_key.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_config_map_requirement.go b/catalog/pkg/openapi/model_mcp_config_map_requirement.go index 8db65abfa7..cd7f2f30e8 100644 --- a/catalog/pkg/openapi/model_mcp_config_map_requirement.go +++ b/catalog/pkg/openapi/model_mcp_config_map_requirement.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_endpoints.go b/catalog/pkg/openapi/model_mcp_endpoints.go index adfaf2757f..dc1b9e020a 100644 --- a/catalog/pkg/openapi/model_mcp_endpoints.go +++ b/catalog/pkg/openapi/model_mcp_endpoints.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_env_var_metadata.go b/catalog/pkg/openapi/model_mcp_env_var_metadata.go index 4555c71311..ab96eb6675 100644 --- a/catalog/pkg/openapi/model_mcp_env_var_metadata.go +++ b/catalog/pkg/openapi/model_mcp_env_var_metadata.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_prerequisites.go b/catalog/pkg/openapi/model_mcp_prerequisites.go index fe27213429..e06666f774 100644 --- a/catalog/pkg/openapi/model_mcp_prerequisites.go +++ b/catalog/pkg/openapi/model_mcp_prerequisites.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_resource_recommendation.go b/catalog/pkg/openapi/model_mcp_resource_recommendation.go index 56d24298e2..a4f48038cc 100644 --- a/catalog/pkg/openapi/model_mcp_resource_recommendation.go +++ b/catalog/pkg/openapi/model_mcp_resource_recommendation.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_resource_recommendation_high.go b/catalog/pkg/openapi/model_mcp_resource_recommendation_high.go index f307bbdaa9..7ebb17f50d 100644 --- a/catalog/pkg/openapi/model_mcp_resource_recommendation_high.go +++ b/catalog/pkg/openapi/model_mcp_resource_recommendation_high.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_resource_recommendation_minimal.go b/catalog/pkg/openapi/model_mcp_resource_recommendation_minimal.go index 7748d158b6..3f17cf65fb 100644 --- a/catalog/pkg/openapi/model_mcp_resource_recommendation_minimal.go +++ b/catalog/pkg/openapi/model_mcp_resource_recommendation_minimal.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_resource_recommendation_recommended.go b/catalog/pkg/openapi/model_mcp_resource_recommendation_recommended.go index d986731dcc..32cd8d16e1 100644 --- a/catalog/pkg/openapi/model_mcp_resource_recommendation_recommended.go +++ b/catalog/pkg/openapi/model_mcp_resource_recommendation_recommended.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_runtime_metadata.go b/catalog/pkg/openapi/model_mcp_runtime_metadata.go index 9a7b89fb40..1609dc3154 100644 --- a/catalog/pkg/openapi/model_mcp_runtime_metadata.go +++ b/catalog/pkg/openapi/model_mcp_runtime_metadata.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_runtime_metadata_capabilities.go b/catalog/pkg/openapi/model_mcp_runtime_metadata_capabilities.go index 456ac67d5d..06ef14a00a 100644 --- a/catalog/pkg/openapi/model_mcp_runtime_metadata_capabilities.go +++ b/catalog/pkg/openapi/model_mcp_runtime_metadata_capabilities.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_runtime_metadata_health_endpoints.go b/catalog/pkg/openapi/model_mcp_runtime_metadata_health_endpoints.go index f94ed1e576..09ca228927 100644 --- a/catalog/pkg/openapi/model_mcp_runtime_metadata_health_endpoints.go +++ b/catalog/pkg/openapi/model_mcp_runtime_metadata_health_endpoints.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_secret_key.go b/catalog/pkg/openapi/model_mcp_secret_key.go index c16664a535..1fc9c32652 100644 --- a/catalog/pkg/openapi/model_mcp_secret_key.go +++ b/catalog/pkg/openapi/model_mcp_secret_key.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_secret_requirement.go b/catalog/pkg/openapi/model_mcp_secret_requirement.go index 5a69173421..b50d85a653 100644 --- a/catalog/pkg/openapi/model_mcp_secret_requirement.go +++ b/catalog/pkg/openapi/model_mcp_secret_requirement.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_security_indicator.go b/catalog/pkg/openapi/model_mcp_security_indicator.go index 91dd3fe420..c25178d742 100644 --- a/catalog/pkg/openapi/model_mcp_security_indicator.go +++ b/catalog/pkg/openapi/model_mcp_security_indicator.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_server.go b/catalog/pkg/openapi/model_mcp_server.go index 74ec15a5b8..8e5551a492 100644 --- a/catalog/pkg/openapi/model_mcp_server.go +++ b/catalog/pkg/openapi/model_mcp_server.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_server_list.go b/catalog/pkg/openapi/model_mcp_server_list.go index 23d9f0e55f..d663c0425d 100644 --- a/catalog/pkg/openapi/model_mcp_server_list.go +++ b/catalog/pkg/openapi/model_mcp_server_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_service_account_requirement.go b/catalog/pkg/openapi/model_mcp_service_account_requirement.go index 8766bce973..32ce7f0c6a 100644 --- a/catalog/pkg/openapi/model_mcp_service_account_requirement.go +++ b/catalog/pkg/openapi/model_mcp_service_account_requirement.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_tool.go b/catalog/pkg/openapi/model_mcp_tool.go index 6b52c453d8..1557c18013 100644 --- a/catalog/pkg/openapi/model_mcp_tool.go +++ b/catalog/pkg/openapi/model_mcp_tool.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_tool_parameter.go b/catalog/pkg/openapi/model_mcp_tool_parameter.go index ce130a95e8..38bf9bded1 100644 --- a/catalog/pkg/openapi/model_mcp_tool_parameter.go +++ b/catalog/pkg/openapi/model_mcp_tool_parameter.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_tool_with_server.go b/catalog/pkg/openapi/model_mcp_tool_with_server.go index a61175b35e..d4f9127418 100644 --- a/catalog/pkg/openapi/model_mcp_tool_with_server.go +++ b/catalog/pkg/openapi/model_mcp_tool_with_server.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_mcp_tools_list.go b/catalog/pkg/openapi/model_mcp_tools_list.go index 4e042d02cc..3fd41d7dc4 100644 --- a/catalog/pkg/openapi/model_mcp_tools_list.go +++ b/catalog/pkg/openapi/model_mcp_tools_list.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_bool_value.go b/catalog/pkg/openapi/model_metadata_bool_value.go index aeb75906e1..9c348d2664 100644 --- a/catalog/pkg/openapi/model_metadata_bool_value.go +++ b/catalog/pkg/openapi/model_metadata_bool_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_double_value.go b/catalog/pkg/openapi/model_metadata_double_value.go index 0f7656731e..702208a1ef 100644 --- a/catalog/pkg/openapi/model_metadata_double_value.go +++ b/catalog/pkg/openapi/model_metadata_double_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_int_value.go b/catalog/pkg/openapi/model_metadata_int_value.go index 90838106e5..4fc420c4ac 100644 --- a/catalog/pkg/openapi/model_metadata_int_value.go +++ b/catalog/pkg/openapi/model_metadata_int_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_proto_value.go b/catalog/pkg/openapi/model_metadata_proto_value.go index 38cc2ebce6..ec2554eb52 100644 --- a/catalog/pkg/openapi/model_metadata_proto_value.go +++ b/catalog/pkg/openapi/model_metadata_proto_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_string_value.go b/catalog/pkg/openapi/model_metadata_string_value.go index 5145325950..c628bd565f 100644 --- a/catalog/pkg/openapi/model_metadata_string_value.go +++ b/catalog/pkg/openapi/model_metadata_string_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_struct_value.go b/catalog/pkg/openapi/model_metadata_struct_value.go index 461cb3a807..2e487dd3f1 100644 --- a/catalog/pkg/openapi/model_metadata_struct_value.go +++ b/catalog/pkg/openapi/model_metadata_struct_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_metadata_value.go b/catalog/pkg/openapi/model_metadata_value.go index d5da8bbb8b..21fd8b1db6 100644 --- a/catalog/pkg/openapi/model_metadata_value.go +++ b/catalog/pkg/openapi/model_metadata_value.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_model_preview_result.go b/catalog/pkg/openapi/model_model_preview_result.go index 026fc49202..8d6038a005 100644 --- a/catalog/pkg/openapi/model_model_preview_result.go +++ b/catalog/pkg/openapi/model_model_preview_result.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_order_by_field.go b/catalog/pkg/openapi/model_order_by_field.go index 62842ba968..483bc22eb7 100644 --- a/catalog/pkg/openapi/model_order_by_field.go +++ b/catalog/pkg/openapi/model_order_by_field.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/model_sort_order.go b/catalog/pkg/openapi/model_sort_order.go index 0a9a63ed54..2b81b6dd01 100644 --- a/catalog/pkg/openapi/model_sort_order.go +++ b/catalog/pkg/openapi/model_sort_order.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/response.go b/catalog/pkg/openapi/response.go index f881c50586..4cd656ec07 100644 --- a/catalog/pkg/openapi/response.go +++ b/catalog/pkg/openapi/response.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/catalog/pkg/openapi/utils.go b/catalog/pkg/openapi/utils.go index 1f1b3f00d0..94c7286976 100644 --- a/catalog/pkg/openapi/utils.go +++ b/catalog/pkg/openapi/utils.go @@ -1,7 +1,7 @@ /* -Model Catalog REST API +Catalog REST API -REST API for Model Registry to create and manage ML model metadata +REST API for Kubeflow Hub Catalog API version: v1alpha1 */ diff --git a/clients/python/README.md b/clients/python/README.md index a2ee4e89c3..74b90aaf8a 100644 --- a/clients/python/README.md +++ b/clients/python/README.md @@ -1,6 +1,6 @@ # Model Registry Python Client -[![Python](https://img.shields.io/badge/python%20-3.9%7C3.10%7C3.11%7C3.12-blue)](https://github.com/kubeflow/model-registry) +[![Python](https://img.shields.io/badge/python%20-3.9%7C3.10%7C3.11%7C3.12-blue)](https://github.com/kubeflow/hub) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../../LICENSE) [![Read the Docs](https://img.shields.io/readthedocs/model-registry)](https://model-registry.readthedocs.io/en/latest/) [![Tutorial Website](https://img.shields.io/badge/Website-green?style=plastic&label=Tutorial&labelColor=blue)](https://www.kubeflow.org/docs/components/model-registry/getting-started/) @@ -11,7 +11,7 @@ This library provides a high level interface for interacting with a model regist > > This Kubeflow component has **alpha** status with limited support. > See the [Kubeflow versioning policies](https://www.kubeflow.org/docs/started/support/#application-status). -> The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/model-registry) about the usability of the feature. +> The Kubeflow team is interested in your [feedback](https://github.com/kubeflow/hub) about the usability of the feature. ## Installation @@ -176,7 +176,7 @@ for version in registry.get_model_versions("my-model"): ... # your logic using `version` loop variable here ``` -