Installation Guide

Quick Install

pip install frameworm

From Source

git clone https://github.com/Aakash0440/frameworm
cd frameworm
pip install -e .

Verify Installation

frameworm --version
frameworm --help

Optional Dependencies

For Bayesian Optimization

pip install scikit-optimize

For ONNX Export

pip install onnx onnxruntime

For Deployment

pip install fastapi uvicorn

Shell Completion

Bash

frameworm completion --shell bash >> ~/.bashrc
source ~/.bashrc

Zsh

frameworm completion --shell zsh >> ~/.zshrc
source ~/.zshrc

GPU Support

FRAMEWORM supports CUDA out of the box with PyTorch.

Check GPU availability:

python -c "import torch; print(torch.cuda.is_available())"

Troubleshooting

Import Errors

Make sure all dependencies are installed:

pip install -r requirements.txt

CUDA Issues

Install appropriate PyTorch version:

pip install torch torchvision --index-url https://download.pytorch.org/whl/cu118