From c6c2c68fd7cee27bcf16fc5b3e2a59f19145cd4d Mon Sep 17 00:00:00 2001 From: Nick Stogner Date: Sat, 28 Sep 2024 16:30:31 -0400 Subject: [PATCH] Add example: python Models client (#255) Add example that shows how to manage Models using python. --- docs/how-to/install-models.md | 4 + examples/k8s-api-clients/python/.gitignore | 162 ++++++++++++++++++ examples/k8s-api-clients/python/example.py | 40 +++++ .../k8s-api-clients/python/requirements.txt | 1 + 4 files changed, 207 insertions(+) create mode 100644 examples/k8s-api-clients/python/.gitignore create mode 100644 examples/k8s-api-clients/python/example.py create mode 100644 examples/k8s-api-clients/python/requirements.txt diff --git a/docs/how-to/install-models.md b/docs/how-to/install-models.md index 472cde75..e1076346 100644 --- a/docs/how-to/install-models.md +++ b/docs/how-to/install-models.md @@ -54,6 +54,10 @@ kubectl explain models.spec kubectl explain models.spec.engine ``` +## Programmatically installing models + +See the [examples](https://github.com/substratusai/kubeai/tree/main/examples/k8s-api-clients). + ## Feedback welcome: A model management UI We are considering adding a UI for managing models in a running KubeAI instance. Give the [GitHub Issue](https://github.com/substratusai/kubeai/issues/148) a thumbs up if you would be interested in this feature. diff --git a/examples/k8s-api-clients/python/.gitignore b/examples/k8s-api-clients/python/.gitignore new file mode 100644 index 00000000..efa407c3 --- /dev/null +++ b/examples/k8s-api-clients/python/.gitignore @@ -0,0 +1,162 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ \ No newline at end of file diff --git a/examples/k8s-api-clients/python/example.py b/examples/k8s-api-clients/python/example.py new file mode 100644 index 00000000..f55838d6 --- /dev/null +++ b/examples/k8s-api-clients/python/example.py @@ -0,0 +1,40 @@ +from kubernetes import config, dynamic +from kubernetes.client import api_client + +k8s_client = dynamic.DynamicClient( + api_client.ApiClient(configuration=config.load_kube_config()) +) + +models_client = k8s_client.resources.get(api_version="kubeai.org/v1", kind="Model") + +model = { + "apiVersion": "kubeai.org/v1", + "kind": "Model", + "metadata": { + "name": "facebook-opt-125m", + "namespace": "default", + }, + "spec": { + "features": ["TextGeneration"], + "owner": "facebook", + "url": "hf://facebook/opt-125m", + "engine": "VLLM", + "resourceProfile": "cpu:1", + }, +} + + +models_client.create(body=model) + +# Alternative: Use "server-side apply" (i.e. kubectl apply) to upsert the Model. +# models_client.patch( +# body=model, +# content_type="application/apply-patch+yaml", +# field_manager="my-example-app", # Set a field manager to track ownership of fields. +# ) + +created_model = models_client.get(name="facebook-opt-125m", namespace="default") +print(created_model) + +# Optionally delete the Model. +# models_client.delete(name="facebook-opt-125m", namespace="default") diff --git a/examples/k8s-api-clients/python/requirements.txt b/examples/k8s-api-clients/python/requirements.txt new file mode 100644 index 00000000..3d3729e3 --- /dev/null +++ b/examples/k8s-api-clients/python/requirements.txt @@ -0,0 +1 @@ +kubernetes==31.0.0