Skip to main content

CLI tool for interacting with the Felafax platform; fine-tuning and inference on non-NVIDIA chipsets.

Project description


title: 'CLI Reference' description: 'Command-line interface for fine-tuning and managing large language models'

Installation

Install the Felafax CLI using pip:

pip install felafax-cli

Authentication

Before using the CLI, authenticate with your token:

felafax-cli auth login --token <your-token>
Use the `--force` flag to override existing authentication.

Core Features

Model Management

List Models

View all your available fine-tuned models:

felafax-cli model list

Interactive Chat

Start an interactive chat session with a model:

felafax-cli model chat <model_id> [--system-prompt "Your custom prompt"]

Model Information

Get detailed information about a specific model:

felafax-cli model info <model_id>

Delete Model

Remove a fine-tuned model:

felafax-cli model delete <model_id>

Training Management

Initialize Configuration

Create a new configuration file:

felafax-cli tune init-config

Start Fine-tuning

Launch a new fine-tuning job:

felafax-cli tune start \
    --model <model_name> \
    --config path/to/config.yml \
    --dataset <dataset_id>

Manage Jobs

# List all training jobs
felafax-cli tune list

# Check job status
felafax-cli tune status --job-id <id>

# Stop a running job
felafax-cli tune stop --job-id <id>

File Management

List Files

View all your training data files:

felafax-cli files list [--prefix <prefix>] [--limit <number>]

Upload File

Upload a new training data file:

felafax-cli files upload <file_path>

Delete File

Remove a training data file:

felafax-cli files delete <file_path>

Configuration

Configuration Example

When you run felafax-cli tune init-config, it creates a YAML 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

Support

For more information, visit our documentation at https://docs.felafax.ai

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

felafax_cli-0.1.17.tar.gz (65.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

felafax_cli-0.1.17-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

Details for the file felafax_cli-0.1.17.tar.gz.

File metadata

  • Download URL: felafax_cli-0.1.17.tar.gz
  • Upload date:
  • Size: 65.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.1

File hashes

Hashes for felafax_cli-0.1.17.tar.gz
Algorithm Hash digest
SHA256 9251358acabe1a25a6a4683c56579452863d2e552e5c597fc3811846ca96c7e1
MD5 65254af03ee6c350aa5d92332f8c569b
BLAKE2b-256 99d329a8fe7353fff6fb8198a5e58be7c2dbae87e7fd63da413ffc5da3ec7826

See more details on using hashes here.

File details

Details for the file felafax_cli-0.1.17-py3-none-any.whl.

File metadata

  • Download URL: felafax_cli-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 54.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.1

File hashes

Hashes for felafax_cli-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9b6e754de8f4cab622525e721de49a833eded5a6a4d8727838e78b750f68f1a0
MD5 69b84ab2a6ec78e80a2b6a78af3a461e
BLAKE2b-256 be84004895f854cdafc524d86a74fa003e28aecb149315a29daa02c7e2a0ba68

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page