Skip to content

docs: add aikit to integrations #1303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Aug 2, 2025
Merged

docs: add aikit to integrations #1303

merged 5 commits into from
Aug 2, 2025
+141 −0

Conversation

sozercan
Copy link
Collaborator

@sozercan sozercan commented Jul 23, 2025 •
edited
Loading

Reason for Change:

Adds AIKit as part of integrations to extend KAITO with CPU-based inference, and increased custom model support with a variety of different formats.

Requirements

  • added unit tests and e2e tests (if applicable).

Issue Fixed:
Fixes #1212

Notes for Reviewers:
I'll update versioned docs after LGTM

@sozercan
docs: add aikit to integrations
774b569 
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
@kaito-pr-agent Kaito PR Agent
Copy link

Title

Add AIKit Integration Documentation

Description

  • Added AIKit integration documentation

  • Updated sidebar to include AIKit category

Changes walkthrough 📝

Relevant files
Documentation
sidebars.js
Add AIKit to sidebar integrations                                               

website/sidebars.js

  • Added a new category for 'Integrations'
  • Included 'aikit' under the Integrations category
    		• +8/-0     
    aikit.md
    Add AIKit integration documentation                                           

    website/docs/aikit.md

  • Created new markdown file for AIKit integration
  • Documented overview, deployment steps, and custom model creation
    		• +117/-0 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    		•

    @kaito-pr-agent Kaito PR Agent
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Typo

    There is a typo in the text: "Create a KAITO workspacec configuration file" should be "Create a KAITO workspace configuration file".

     
    Create a KAITO workspacec configuration file to deploy your model. Here's a complete example:
    Missing Link

    The link to the installation guide in step 41 is incorrect. It points to "installation.md#install-workspace-controller", but the correct path should be verified as it might not exist or be incorrectly referenced.

     
    - Install [KAITO workspace controller](installation.md#install-workspace-controller) on your cluster

    @kaito-pr-agent Kaito PR Agent
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Adjust category collapse setting

    Ensure that the collapsed property is consistent with the intended user experience.
    Consider setting it to true if you want the category to be collapsed by default.

    website/sidebars.js [43-50]

     {
     type: 'category',
     label: 'Integrations',
-    collapsed: false,
+    collapsed: true,
     items: [
         'aikit',
     ],
 },
    Suggestion importance[1-10]: 6

    __

    Why: The suggestion asks to verify or ensure a change in the collapsed property, which is a minor improvement affecting user experience but not critical functionality.

    		Low
    Fix spelling error

    Correct the typo in "workspacec" to "workspace".

    website/docs/aikit.md [45]

    -Create a KAITO workspacec configuration file to deploy your model.
+Create a KAITO workspace configuration file to deploy your model.
    Suggestion importance[1-10]: 5

    __

    Why: Correcting the typo in "workspacec" to "workspace" is a minor improvement that enhances readability but does not affect functionality.

    		Low

    @sozercan
    Merge branch 'main' into docs-aikit
    70b1dc2 
    Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
    @sozercan
    fix link
    e8c605a 
    Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
    @zhuangqh
    Copy link
    Collaborator

    This feature is awesome! Let's add a e2e test for it.

    zhuangqh
    zhuangqh reviewed Jul 29, 2025
    View reviewed changes
    website/docs/aikit.md
    - "run"
    - "--address=:5000"
    ```

    Copy link
    Collaborator

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    could you add a hint here? users may need to check the memory requirement before they deploy a cpu model and add these requirements to the spec.

    OOM is the most common problem we met during deploying a llm model.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    thanks, added a note. it is hard to get exact requirements, but i added general guidelines, and a way to get more accurate estimation.

    Fei-Guo
    Fei-Guo reviewed Jul 30, 2025
    View reviewed changes
    website/docs/aikit.md
    ```

    After building the image, you can use it in your KAITO workspace configuration by updating the `image` field.

    Copy link
    Collaborator

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Can you also call out the limitations here. What are supported runtimes or anything that works in local AI but not included in this integration.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    thanks, added a note at the end.

    @sozercan
    review comments
    40e0bc2 
    Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
    @sozercan
    Copy link
    Collaborator Author

    sozercan commented Aug 1, 2025

    @zhuangqh thanks! we can follow up with e2e after docs pr is merged, wdyt?

    @sozercan sozercan requested review from Fei-Guo and zhuangqh August 1, 2025 20:13
    zhuangqh
    zhuangqh approved these changes Aug 2, 2025
    View reviewed changes
    Copy link
    Collaborator

    @zhuangqh zhuangqh left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @Fei-Guo Fei-Guo merged commit fa41991 into kaito-project:main Aug 2, 2025
    15 of 16 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @chewong chewong chewong approved these changes

    @zhuangqh zhuangqh zhuangqh approved these changes

    @Fei-Guo Fei-Guo Fei-Guo approved these changes

    Assignees
    No one assigned
    Labels
    Review effort 3/5
    Projects
    KAITO Roadmap
    Status: Done
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.

    support for cpu based inference
    4 participants
    @sozercan @zhuangqh @chewong @Fei-Guo