Skip to main content
Prerequisite: Please ensure you have Python installed and pip package manager configured.

​
Installation

Install Felafax CLI using pip: 
pip install felafax-cli

​
Quick Start

Follow these steps to get started with Felafax:

​
Step 1: Authentication

Authenticate your CLI session: 
felafax-cli auth login --token <your-token>

​
Step 2: Initialize Configuration

Set up your initial configuration: 
felafax-cli tune init-config

​
Step 3: Upload Training Data

Upload your training dataset: 
felafax-cli files upload path/to/data.jsonl

​
Step 4: Start Fine-tuning

Begin the fine-tuning process: 
felafax-cli tune start --model <model_name> --config config.yml --dataset <dataset_id>

​
Available Commands

​
Training Management

felafax-cli tune init-config

​
File Management

felafax-cli files list

​
Model Operations

felafax-cli model list

​
Configuration

Create a config.yml file with the following structure: 
hyperparameters:
  learning_rate: 1.0e-05
  batch_size: 32
  n_epochs: 4
  warmup_ratio: 0.0
lora:
  enabled: false
  r: 8
  alpha: 8
  dropout: 0.0

​
Development Setup

python3 -m build

python3 -m venv env
source env/bin/activate  # Unix/MacOS
# or
env\Scripts\activate     # Windows

pip install -e .