Skip to content
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.

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

Add python API for programmatic access #54

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

rohan-uiuc
Copy link

@rohan-uiuc rohan-uiuc commented Mar 2, 2025

PR Type

Feature

Short Description

  • Add programmatic access through a Python API. This enables developers to integrate model management capabilities directly into their applications and scripts. The API provides methods for listing models, launching models with custom configurations, monitoring model status, retrieving performance metrics, and shutting down models when done.
  • Move shared functionality to a shared package.
  • Add python API docs and update the existing user guide
  • Fix the examples for python API usage

Tests Added

API functionality tests for listing models, launching models, checking status, and waiting for readiness

@rohan-uiuc rohan-uiuc mentioned this pull request Mar 2, 2025
5 tasks
@amrit110
Copy link
Member

amrit110 commented Mar 5, 2025

@rohan-uiuc thanks for the PR. We like the idea of a python API, and the example usage is much appreciated. As a first step, I will make changes to your PR to refactor some stuff (noticed there is some duplication like the ModelConfig, and clean up the lint errors). Stay tuned.

@rohan-uiuc
Copy link
Author

@amrit110 that sounds good, thank you!

@amrit110 amrit110 added the enhancement New feature or request label Mar 16, 2025
@amrit110 amrit110 requested review from XkunW and jwilles March 16, 2025 20:35
@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants