Skip to content

Commit

Permalink
Kaito Docs (#1109)
Browse files Browse the repository at this point in the history
  • Loading branch information
tejhan authored Dec 6, 2024
1 parent bf35784 commit 8266ae2
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 28 deletions.
3 changes: 2 additions & 1 deletion docs/book/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Azure Kubernetes Service (AKS) Extension for Visual Studio Code helps enable AKS
* [Run Image Cleaner Eraser Tool](./features/image-cleaner-eraser-tool.md)
* [Run Retina Capture](./features/retina-capture.md)
* [Run Automated Deployments Commands](./features/draft-integration.md)
* [Install & Deploy KAITO Models](./features/kaito-integration.md)
* [Install and Deploy KAITO Models](./features/kaito-install-deploy.md)
* [Manage and Test KAITO Deployments](./features/kaito-manage-test.md)

## Development and Release

Expand Down
3 changes: 2 additions & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
- [Run Retina Capture](./features/retina-capture.md)
- [Run Draft Command](./features/draft-integration.md)
- [AKS plugins for GitHub Copilot for Azure](./features/aks-plugins-github-copilot.md)
- [Install & Deploy KAITO Models](./features/kaito-integration.md)
- [Install and Deploy KAITO Models](./features/kaito-install-deploy.md)
- [Manage and Test KAITO Deployments](./features/kaito-manage-test.md)

- [Release](./release.md)
- [Releasing Information](./release/releasing.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/book/src/features/kaito-install-deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Install and Deploy KAITO models

The KAITO integration enables seamless installation of KAITO onto your clusters, empowering you to deploy AI models, manage workflows, and test deployments with ease and precision.

### Install KAITO

Right click on your desired AKS cluster and select **Deploy an LLM with KAITO** and then click on **Install KAITO** to open up the KAITO installation page.

![Installation Page](../resources/kaito-installation-page.png)

Once on the page, click **Install KAITO** and the KAITO installation process will begin. Once KAITO has been successfully installed, you will be prompted with a "Generate Workspace" button that will redirect you to the model deployment page.

![Successfull Installation](../resources/kaito-installation-success.png)

### Deploy a model

Right click on an AKS cluster that has KAITO successfully installed and select **Deploy an LLM with KAITO** and then click on **Create KAITO Workspace** to open the KAITO model deployment page.

![Deployment Page](../resources/kaito-deploy-page.png)

Once on this page, you can click any of the models to open up the side panel, which will present you with the option to either **Deploy Default workspace CRD** or **Customize Workspace CRD**.

Click **Deploy Default workspace CRD** to deploy the model. It will track the progress of the model and notify you once the model has been successfully deployed. It will also notify you if the model was already previously unsucessfully onto your cluster. Upon successful deployment, you will be prompted with a "View Deployed Models" button that will redirect you to the deployment management page.

![Phi-2 Model Being Deployed](../resources/kaito-deployment-example-in-progress.png)
![Phi-2 Model Successfully Deployed](../resources/kaito-deployment-example-success.png)

Click **Customize Workspace CRD** to open up a CRD file pre-populated with the infromation necessary to deploy the model. You can alter this file to your desires and save it locally.
26 changes: 0 additions & 26 deletions docs/book/src/features/kaito-integration.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/book/src/features/kaito-manage-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Manage and Test KAITO Deployments

Actively monitor the the status of all KAITO deployments on the cluster, retrieve logs, test the inference servers, and delete/redeploy models.

### Manage KAITO Deployments

Right click on your desired AKS cluster and select **Deploy an LLM with KAITO** and then click on **Manage KAITO Models**.

![Manage Page](../resources/kaito-manage-page.png)

Once on this page, you will see all existing KAITO deployments on the cluster, alongside their status (ongoing, successful, or failed).

For your selected deployment, click **Get Logs** to access the latest logs from the KAITO workspace pods. This action will generate a new text file containing the most recent 500 lines of logs.

To delete a model, select **Delete Workspace** (or **Cancel** for ongoing deployments). For failed deployments, choose **Re-deploy Default CRD** to remove the current deployment and restart the model deployment process from scratch.

### Test a Model

On your desired model, select **Test** to access the model testing page.

![Test Page](../resources/kaito-test-page.png)

Once on the testing page, you can modify the parameters and enter a prompt for submsission. Click **Reset Params** to reset all configurable parameters to their default values. Click **Submit Prompt** to submit your query.

![Query Response](../resources/kaito-test-response.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/book/src/resources/kaito-install-page.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book/src/resources/kaito-manage-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book/src/resources/kaito-test-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/book/src/resources/kaito-test-response.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8266ae2

Please sign in to comment.