This commit is contained in:
2026-05-20 14:13:21 -04:00
parent 2618b30d40
commit 75255b37d0
7 changed files with 27 additions and 27 deletions

View File

@@ -1,4 +1,4 @@
# qai-cli
# qc-cli
A CLI for the Qualcomm model MLOps pipeline — browse and download models from Qualcomm AI Hub, fine-tune them on custom datasets using SageMaker, validate inference, and prepare artifacts for Qualcomm hardware deployment.
@@ -6,40 +6,40 @@ A CLI for the Qualcomm model MLOps pipeline — browse and download models from
- Python 3.13+
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- AWS account with credentials configured (`aws configure`) when using `qai-cli infra`
- AWS CDK CLI (`npm install -g aws-cdk`) when using `qai-cli infra setup` or `qai-cli infra destroy`
- AWS account with credentials configured (`aws configure`) when using `qc-cli infra`
- AWS CDK CLI (`npm install -g aws-cdk`) when using `qc-cli infra setup` or `qc-cli infra destroy`
## Installation
```bash
git clone <repo>
cd qai-cli
cd qc-cli
uv sync
```
Run commands with `uv run qai-cli <command>` or activate the venv first:
Run commands with `uv run qc-cli <command>` or activate the venv first:
```bash
source .venv/bin/activate
qai-cli --help
qc-cli --help
```
## Quick start
```bash
# 1. Create config.yaml in the current directory
qai-cli init
qc-cli init
# 2. Edit config.yaml — at minimum set s3.bucket and sagemaker.role_name
# 3. Provision AWS infrastructure (S3 bucket + SageMaker IAM role).
# This is the step that requires the AWS CDK CLI.
qai-cli infra setup
qc-cli infra setup
```
## Configuration
`qai-cli init` writes a `config.yaml` in the current directory. The fields you must fill in before using the tool:
`qc-cli init` writes a `config.yaml` in the current directory. The fields you must fill in before using the tool:
```yaml
aws:
@@ -50,7 +50,7 @@ s3:
bucket: your-unique-bucket-name
sagemaker:
role_name: qai-cli-sagemaker-role
role_name: qc-cli-sagemaker-role
```
To provision an MLflow tracking server, set:
@@ -74,21 +74,21 @@ mlflow:
### `init`
```
qai-cli init Write config.yaml
qai-cli init --output <path> Write config to a custom path
qai-cli init --force Overwrite an existing config file
qc-cli init Write config.yaml
qc-cli init --output <path> Write config to a custom path
qc-cli init --force Overwrite an existing config file
```
### `infra`
```
qai-cli infra setup Deploy the CDK stack
qai-cli infra setup --no-bootstrap Deploy without running CDK bootstrap
qai-cli infra setup --cloudformation-execution-policy <arn> Set CDK bootstrap execution policy ARN
qai-cli infra status Show CDK stack/resource status
qai-cli infra destroy Destroy stack, retaining S3 data
qai-cli infra destroy --yes Destroy stack without confirmation
qai-cli infra destroy --delete-bucket-data Destroy stack and delete S3 data
qc-cli infra setup Deploy the CDK stack
qc-cli infra setup --no-bootstrap Deploy without running CDK bootstrap
qc-cli infra setup --cloudformation-execution-policy <arn> Set CDK bootstrap execution policy ARN
qc-cli infra status Show CDK stack/resource status
qc-cli infra destroy Destroy stack, retaining S3 data
qc-cli infra destroy --yes Destroy stack without confirmation
qc-cli infra destroy --delete-bucket-data Destroy stack and delete S3 data
```
## AWS permissions required