Skip to content

Commit e84d8f0

Browse files
authored
fix 404's in the docs (#860)
Signed-off-by: Javis Pérez <[email protected]>
1 parent fd60545 commit e84d8f0

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For our friends in the EU - ModelKits are the perfect way to create a library of
3838

3939
* 🚢 Create a **[runnable container from a ModelKit](https://tinyurl.com/5b76p5u3)** with one command! Read [KitOps deploy docs](https://kitops.org/docs/deploy/) for details.
4040
* 🥂 Get the most out of KitOps' ModelKits by using them with the **[Jozu Hub](https://jozu.ml/)** repository. Or, continue using ModelKits with your existing OCI registry (even on-premises and air-gapped).
41-
* 🛠️ Use KitOps with Dagger pipelines using our modules from the [Daggerverse](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit).
41+
* 🛠️ Use KitOps with Dagger pipelines using our modules from the [Daggerverse](https://github.com/kitops-ml/daggerverse).
4242
* ⛑️ [KitOps works great with Red Hat](https://developers.redhat.com/articles/2024/09/16/enhance-llms-instructlab-kitops) InstructLab and Quay.io products.
4343

4444

@@ -48,7 +48,7 @@ For our friends in the EU - ModelKits are the perfect way to create a library of
4848
* 🏭 **[Versioning](https://kitops.org/docs/cli/cli-reference/#kit-tag):** Each ModelKit is tagged so everyone knows which dataset and model work together.
4949
* 🔒 **[Tamper-proofing](https://kitops.org/docs/modelkit/spec/):** Each ModelKit package includes an SHA digest for itself, and every artifact it holds.
5050
* 🤩 **[Selective-unpacking](https://kitops.org/docs/cli/cli-reference/#kit-unpack):** Unpack only what you need from a ModelKit with the `kit unpack --filter` command - just the model, just the dataset and code, or any other combination.
51-
* 🤖 **[Automation](https://github.com/marketplace/actions/setup-kit-cli):** Pack or unpack a ModelKit locally or as part of your CI/CD workflow for testing, integration, or deployment (e.g. [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli) or [Dagger](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit).
51+
* 🤖 **[Automation](https://github.com/marketplace/actions/setup-kit-cli):** Pack or unpack a ModelKit locally or as part of your CI/CD workflow for testing, integration, or deployment (e.g. [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli) or [Dagger](https://github.com/kitops-ml/daggerverse).
5252
* 🐳 **[Deploy containers](https://kitops.org/docs/deploy/):** Generate a basic or custom docker container from any ModelKit.
5353
* 🚢 **[Kubernetes-ready](https://kitops.org/docs/deploy/):** Generate a Kubernetes / KServe deployment config from any ModelKit.
5454
* 🪛 **[LLM fine-tuning](https://dev.to/kitops/fine-tune-your-first-large-language-model-llm-with-lora-llamacpp-and-kitops-in-5-easy-steps-1g7f):** Use KitOps to fine-tune a large language model using LoRA.
@@ -57,7 +57,7 @@ For our friends in the EU - ModelKits are the perfect way to create a library of
5757
* 🌈 **[Standards-based](https://kitops.org/docs/modelkit/compatibility/):** Store ModelKits in any OCI 1.1-compliant container or artifact registry.
5858
* 🥧 **[Simple syntax](https://kitops.org/docs/kitfile/kf-overview/):** Kitfiles are easy to write and read, using a familiar YAML syntax.
5959
* 🩰 **[Flexible](https://kitops.org/docs/kitfile/format/#model):** Reference base models using `model parts`, or store key-value pairs (or any YAML-compatible JSON data) in your Kitfile - use it to keep features, hyperparameters, links to MLOps tool experiments, or validation output.
60-
* 🏃‍♂️‍➡️ **[Run locally](./docs/src/docs/dev-mode.md):** Kit's Dev Mode lets you run an LLM locally, configure it, and prompt/chat with it instantly.
60+
* 🏃‍♂️‍➡️ **[Run locally](./docs/src/docs/deploy.md#running-llms-locally):** Kit's Dev Mode lets you run an LLM locally, configure it, and prompt/chat with it instantly.
6161
* 🤗 **Universal:** ModelKits can be used with any AI, ML, or LLM project - even multi-modal models.
6262

6363
### See KitOps in Action
@@ -98,10 +98,10 @@ We ❤️ our KitOps community and contributors. To learn more about the many wa
9898

9999
#### 📢 KitOps Community Calls (bi-weekly)
100100

101-
**Wednesdays @ 13:30 – 14:00**
102-
**Time zone**: America/Toronto
103-
**Video call link**: [Google Meet](https://meet.google.com/zfq-uprp-csd)
104-
Or dial: (CA) +1 647-736-3184 PIN: 144 931 404#
101+
**Wednesdays @ 13:30 – 14:00**
102+
**Time zone**: America/Toronto
103+
**Video call link**: [Google Meet](https://meet.google.com/zfq-uprp-csd)
104+
Or dial: (CA) +1 647-736-3184 PIN: 144 931 404#
105105
More phone numbers: [Phone Numbers](https://tel.meet/zfq-uprp-csd?pin=1283456375953)
106106

107107
### A Community Built on Respect

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# KitOps Documentation
55

6-
This is the documentation for [KitsOps](https://kitops.org). You can read the docs at https://kitops.org/docs/overview.html.
6+
This is the documentation for [KitsOps](https://kitops.org). You can read the docs at https://kitops.org/docs/overview/.
77

88
## Table of Contents
99

docs/src/docs/get-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In this guide, we'll use ModelKits and the kit CLI to easily:
1515
* Package the ModelKit as a container or Kubernetes deployment
1616

1717
:::info
18-
If you're more interested in using KitOps with [MLFlow](../pykitops/mlflow.md) or [CI/CD pipelines](../pykitops/cicd.md) check out our integrations section.
18+
If you're more interested in using KitOps with [MLFlow](../integrations/mlflow.md) or [CI/CD pipelines](../integrations/cicd.md) check out our integrations section.
1919
:::
2020

2121
## Before we start...
@@ -151,8 +151,8 @@ If you'd like to learn more about using Kit, try our [Next Steps with Kit](../ne
151151
* Tagging ModelKits
152152
* Keeping your registry tidy
153153

154-
Or, if you want to run an LLM-based ModelKit locally try our [dev mode](../dev-mode/).
154+
Or, if you want to run an LLM-based ModelKit locally try our [dev mode](../deploy/#running-llms-locally).
155155

156-
Finally, if you're building workflows using Dagger you can use KitOps through our [Daggerverse modules](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit). Or get the [GitHub Action for Kit](https://github.com/marketplace/actions/setup-kit-cli).
156+
Finally, if you're building workflows using Dagger you can use KitOps through our [Daggerverse modules](https://github.com/kitops-ml/daggerverse). Or get the [GitHub Action for Kit](https://github.com/marketplace/actions/setup-kit-cli).
157157

158158
Thanks for taking some time to play with Kit. We'd love to hear what you think. Feel free to drop us an [issue in our GitHub repository](https://github.com/kitops-ml/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy).

docs/src/docs/integrations/cicd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ description: Use KitOps ModelKits to add AI/ML to your CI/CD tool's pipelines.
33
---
44
# Using KitOps ModelKits from a CI/CD Tool
55

6-
To get the most out of KitOps secure ModelKits, many teams and organizations create, push, or pull ModelKits as part of their CI/CD pipelines. For example, when a team finishes tuning of a model, a pipeline will create a ModelKit that includes the model, the tuning dataset used, the artifacts generated by the successful experiment run, and the results of that experiment run.
6+
To get the most out of KitOps secure ModelKits, many teams and organizations create, push, or pull ModelKits as part of their CI/CD pipelines. For example, when a team finishes tuning of a model, a pipeline will create a ModelKit that includes the model, the tuning dataset used, the artifacts generated by the successful experiment run, and the results of that experiment run.
77

88
Typically this is done by installing the Kit CLI and running `kit` commands as tasks in the pipeline.
99

1010
The KitOps community has shared some of their CI/CD tool integrations:
1111
* GitHub Actions: [Tutorial](https://jozu.com/blog/automating-ml-pipeline-with-modelkits-github-actions/), and [Action](https://github.com/marketplace/actions/setup-kit-cli)
1212
* Red Hat OpenShift Pipelines: [Tutorial](https://jozu.com/blog/how-to-turn-your-openshift-pipelines-into-an-mlops-pipeline)
1313
* ArgoCD: [Tutorial](https://jozu.com/blog/deploying-ml-projects-with-argo-cd/)
14-
* Dagger: [Tutorial](https://jozu.com/blog/building-an-mlops-pipeline-with-dagger-io-and-kitops/), and [Module](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit@fc53d7802be6553298f4f54dd73cc1c1913d4ce6)
14+
* Dagger: [Tutorial](https://jozu.com/blog/building-an-mlops-pipeline-with-dagger-io-and-kitops/), and [Module](https://github.com/kitops-ml/daggerverse)
1515

16-
**Questions or suggestions?** Drop an [issue in our GitHub repository](https://github.com/kitops-ml/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy) to get support or share your feedback.
16+
**Questions or suggestions?** Drop an [issue in our GitHub repository](https://github.com/kitops-ml/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy) to get support or share your feedback.

docs/src/docs/integrations/mlflow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Use KitOps PyKitOps Python library to automate ModelKit creation wi
33
---
44
# MLFlow and KitOps ModelKits
55

6-
Many KitOps users automate the creation of secure and tamper-proof [ModelKits](../modelkit/intro.md) for each experiment run in MLFlow. This gives the team and organization a library of models that they can reproduce on any infrastructure.
6+
Many KitOps users automate the creation of secure and tamper-proof [ModelKits](../../modelkit/intro.md) for each experiment run in MLFlow. This gives the team and organization a library of models that they can reproduce on any infrastructure.
77

88
::tip
99
You can follow the instructions below, or in a [community-generated tutorial](https://jozu.com/blog/how-to-use-kitops-with-mlflow/)
@@ -33,7 +33,7 @@ The `ModelKitManager` is then used to pack and upload the artifacts as a ModelKi
3333

3434
In the following code:
3535
`artifact_location` = the directory where the experiment run artifacts were saved
36-
`name` = the name of the ModelKit as it will be displayed in the [Kitfile](../kitfile/kf-overview.md)
36+
`name` = the name of the ModelKit as it will be displayed in the [Kitfile](../../kitfile/kf-overview.md)
3737
`modelkit_tag` = a name for the ModelKit, for example "latest"
3838

3939
```py
@@ -42,7 +42,7 @@ from kitops.modelkit.manager import ModelKitManager
4242
from kitops.modelkit.user import UserCredentials
4343
from kitops.cli import kit
4444

45-
# A password can be read from Environment Variables or .env files: JOZU_PASSWORD=<secret password>
45+
# A password can be read from Environment Variables or .env files: JOZU_PASSWORD=<secret password>
4646
# Add in your own username from the registry that you are accessing, e.g. username=bmicklea
4747
creds = UserCredentials(username=username, registry="jozu.ml")
4848

@@ -62,4 +62,4 @@ kit.init(directory=artifact_location, name=name, description="my cool project",
6262
manager.pack_and_push_modelkit(with_login_and_logout=False)
6363
```
6464

65-
**Questions or suggestions?** Drop an [issue in our GitHub repository](https://github.com/kitops-ml/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy) to get support or share your feedback.
65+
**Questions or suggestions?** Drop an [issue in our GitHub repository](https://github.com/kitops-ml/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy) to get support or share your feedback.

docs/src/docs/modelkit/compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The most fully-featured repository for ModelKits is the [Jozu Hub](https://jozu.
3232

3333
### Pre-Built Workflows
3434

35-
* Dagger: see [Kit modules for Dagger](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit) in the Daggerverse
35+
* Dagger: see [Kit modules for Dagger](https://github.com/kitops-ml/daggerverse) in the Daggerverse
3636
* GitHub Actions: Kit CLI for [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli)
3737

3838
## Other Compatible Tools

docs/src/docs/use-cases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Security conscious organizations often can't allow internal teams to use any pub
2222
* They don't match the organization's security testing requirements
2323
* Their provenance isn't understood
2424

25-
In these cases teams may use a pipeline (with [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli), [Dagger](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit), or [another tool](../modelkit/compatibility/)) to pull models or sample datasets from Hugging Face, run them through a battery of tests, then publish them in tamper-proof and signed ModelKits to their private container registry.
25+
In these cases teams may use a pipeline (with [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli), [Dagger](https://github.com/kitops-ml/daggerverse), or [another tool](../modelkit/compatibility/)) to pull models or sample datasets from Hugging Face, run them through a battery of tests, then publish them in tamper-proof and signed ModelKits to their private container registry.
2626

2727
This ensures that:
2828
* __Everyone has a library of safe, immutable, and signed ModelKits__ speeding development without compromising security
@@ -33,7 +33,7 @@ This ensures that:
3333
* __Organizations are protected against vendor shifts__ in their MLOps and Serving Infrastructure domains (this also gives them negotiating leverage with vendors)
3434

3535
**Get Started:**
36-
* [Kit Dagger Modules](https://daggerverse.dev/mod/github.com/kitops-ml/daggerverse/kit): Kit Dagger modules make it easy to pack and selectively unpack ModelKits to speed pipelines.
36+
* [Kit Dagger Modules](https://github.com/kitops-ml/daggerverse): Kit Dagger modules make it easy to pack and selectively unpack ModelKits to speed pipelines.
3737
* [Kit GitHub Action](https://github.com/marketplace/actions/setup-kit-cli): Our Kit GitHub Action is used to build hundreds of ModelKits every day as part of pipelines.
3838
* [Learn to pack and unpack ModelKits](../get-started/)
3939
* [Create containers or Kubernetes deployments directly from ModelKits](../deploy/)

0 commit comments

Comments
 (0)