A simple Ollama-like tool for running LLMs locally
Project description
Easy Edge
A simple Ollama-like tool for running Large Language Models (LLMs) locally using llama.cpp under the hood.
Features
- 🚀 Local LLM Inference: Run models locally using llama.cpp
- 📥 Automatic Downloads: Download models from URLs or Hugging Face
- 💬 Interactive Chat: Chat with models in an interactive terminal
- 📋 Model Management: List, download, and remove models
- ⚙️ Configurable: Customize model parameters and settings
Installation
Install Easy Edge from PyPI:
pip install easy-edge
Or, to install the latest version from source:
git clone https://github.com/criminact/easy-edge.git
cd easy-edge
pip install .
Usage
After installation, use the easy-edge command from your terminal:
Download a Model
easy-edge pull --repo-id TheBloke/Llama-2-7B-Chat-GGUF --filename llama-2-7b-chat.Q4_K_M.gguf
Or download from a Hugging Face URL:
easy-edge pull --url https://huggingface.co/google/gemma-3-1b-it-qat-q4_0-gguf/resolve/main/gemma-3-1b-it-q4_0.gguf
Run the Model
Single prompt:
easy-edge run gemma-3-1b-it-qat-q4_0-gguf --prompt "Hello, how are you?"
Interactive chat:
easy-edge run gemma-3-1b-it-qat-q4_0-gguf --interactive
List Installed Models
easy-edge list
Remove a Model
easy-edge remove gemma-3-1b-it-qat-q4_0-gguf
Configuration
The tool stores configuration in models/config.json. You can modify settings like:
max_tokens: Maximum tokens to generate (default: 2048)temperature: Sampling temperature (default: 0.7)top_p: Top-p sampling parameter (default: 0.9)
Requirements
- Python 3.11+
- 8GB+ RAM (for 7B models)
- 16GB+ RAM (for 13B models)
- 4GB+ free disk space per model
Troubleshooting
Common Issues
-
"llama-cpp-python not installed"
pip install llama-cpp-python
-
Out of memory errors
- Try smaller models (7B instead of 13B)
- Use more quantized models (Q4_K_M instead of Q8_0)
- Close other applications to free up RAM
-
Slow inference
- The tool uses all CPU cores by default
- For better performance, consider using GPU acceleration (requires CUDA)
GPU Acceleration (Optional)
For faster inference with NVIDIA GPUs:
pip uninstall llama-cpp-python
pip install llama-cpp-python --force-reinstall --index-url=https://jllllll.github.io/llama-cpp-python-cuBLAS-wheels/AVX2/cu118
Finetuning Your Own Model
Easy Edge supports finetuning LLMs using a Modelfile (Ollama-style) and Hugging Face Trainer. This allows you to create custom models for your own data and use them locally.
1. Create a Modelfile
A Modelfile describes the base model, training parameters, and example messages for finetuning. Example:
HF_TOKEN <your_huggingface_token>
FROM meta-llama/Llama-3.2-1B-Instruct
PARAMETER device cpu
PARAMETER max_length 64
PARAMETER learning_rate 3e-5
PARAMETER epochs 4
PARAMETER batch_size 1
PARAMETER lora true
PARAMETER lora_r 8
PARAMETER lora_alpha 32
PARAMETER lora_dropout 0.05
PARAMETER lora_target_modules q_proj,v_proj
SYSTEM You are a helpful assistant.
MESSAGE user How can I reset my password?
MESSAGE assistant To reset your password, click on 'Forgot Password' at the login screen and follow the instructions.
HF_TOKENis your Hugging Face access token (required for private models).FROMspecifies the base model to finetune.PARAMETERlines set training options (see above for examples).SYSTEMandMESSAGEblocks provide training data.
2. Run Finetuning
Use the finetune command to start training:
easy-edge finetune --modelfile Modelfile --output my-finetuned-model --epochs 4 --batch-size 1 --learning-rate 3e-5
--modelfileis the path to your Modelfile.--outputis where the trained model will be saved.- You can override epochs, batch size, and learning rate on the command line.
3. Convert to GGUF (for llama.cpp)
After training, you will see instructions to convert your model to GGUF format for use with llama.cpp:
python3 convert_hf_to_gguf.py --in my-finetuned-model --out my-finetuned-model.gguf
Upload your GGUF file to Hugging Face or use it locally with Easy Edge.
Notes
- Finetuning is resource-intensive. For best results, use a machine with a GPU.
- LoRA/PEFT is supported for efficient finetuning.
- See the example Modelfile in the repository for more options.
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
License
MIT License - see LICENSE file for details.
Acknowledgments
- llama.cpp - The underlying inference engine
- Ollama - Inspiration for the tool design
- Hugging Face - Model hosting and distribution
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file easy_edge-0.1.3.tar.gz.
File metadata
- Download URL: easy_edge-0.1.3.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31ee192dfd862da64916060d4af528330f1a7dfdf83fdc2a27e0e477321f890d
|
|
| MD5 |
de4d375fb84ce4aa3989ad6826867d13
|
|
| BLAKE2b-256 |
c1738cc37b05d41d0fcd2b15424d06d7922531ffd4a96f58093f7106b83ffcbb
|
File details
Details for the file easy_edge-0.1.3-py3-none-any.whl.
File metadata
- Download URL: easy_edge-0.1.3-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
384097eaea085fceb0fcbdb07cbc357182df4a33fb1b65d03bad62b10a171596
|
|
| MD5 |
21b3552f149940bb8586bbe3c2dd190c
|
|
| BLAKE2b-256 |
6de44ff3ea09cd2c930eaca564ce625bd2f676dc1e5a3f154cfa701ea9754e04
|