diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d7b06c..1adaea1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [1.0.0] - 2025-08-15 + +### Changed +- **STABLE RELEASE**: MLX Knife 1.0.0 officially stable and ready for production use +- **PyPI Publication**: Now available on PyPI for easy installation via `pip install mlx-knife` +- **CLI-Only Policy**: Officially designated as CLI-only tool (Python API access not officially supported) +- **Documentation**: Updated all documentation to reflect stable 1.0.0 release status + ## [1.0-rc3] - 2025-08-14 ### Added diff --git a/README.md b/README.md index 313f43d..f8a6c8f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# BROKE Logo MLX Knife +# BROKE Logo MLX Knife

- MLX Knife Demo + MLX Knife Demo

-A lightweight, ollama-like CLI for managing and running MLX models on Apple Silicon. **Designed for personal, local use** - perfect for individual developers and researchers working with MLX models. +A lightweight, ollama-like CLI for managing and running MLX models on Apple Silicon. **CLI-only tool designed for personal, local use** - perfect for individual developers and researchers working with MLX models. -**Current Version**: 1.0-rc3 (August 2025) +> **Note**: MLX Knife is designed as a command-line interface tool only. While some internal functions are accessible via Python imports, only CLI usage is officially supported. + +**Current Version**: 1.0.0 (August 2025) [![GitHub Release](https://img.shields.io/github/v/release/mzau/mlx-knife)](https://github.com/mzau/mlx-knife/releases) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) @@ -48,6 +50,16 @@ A lightweight, ollama-like CLI for managing and running MLX models on Apple Sili ## Installation +### Via PyPI (Recommended) +```bash +pip install mlx-knife +``` + +### Via GitHub (Development) +```bash +pip install git+https://github.com/mzau/mlx-knife.git +``` + ### Requirements - macOS with Apple Silicon (M1/M2/M3) - Python 3.9+ (native macOS version or newer) diff --git a/SECURITY.md b/SECURITY.md index 5a9d967..5214828 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -98,7 +98,7 @@ mlxk server --host 0.0.0.0 --port 8000 | Version | Supported | | ------- | ------------------ | -| 1.0-rc3 | :white_check_mark: | +| 1.0.0 | :white_check_mark: | | < 1.0 | :x: | ## Additional Resources diff --git a/TESTING.md b/TESTING.md index e874320..7fbe200 100644 --- a/TESTING.md +++ b/TESTING.md @@ -141,7 +141,7 @@ pytest --durations=10 pytest -n auto ``` -## Test Results Summary (1.0-rc3) +## Test Results Summary (1.0.0) ### ✅ Current Test Status (August 2025) @@ -173,7 +173,7 @@ Total Tests: 104/104 passing (100% ✅) ## Python Version Compatibility ### Compatibility Status -MLX Knife 1.0-rc3 is fully compatible with Python 3.9-3.13. Comprehensive verification completed with 104/104 tests passing on all supported versions. +MLX Knife 1.0.0 is fully compatible with Python 3.9-3.13. Comprehensive verification completed with 104/104 tests passing on all supported versions. ### Manual Multi-Python Testing @@ -346,7 +346,7 @@ When submitting PRs, please include: ## Summary -**MLX Knife 1.0-rc3 Testing Status:** +**MLX Knife 1.0.0 Testing Status:** ✅ **Production Ready** - 104/104 tests passing ✅ **Multi-Python Support** - Python 3.9-3.13 verified diff --git a/mlx_knife/__init__.py b/mlx_knife/__init__.py index 30af410..8349dbe 100644 --- a/mlx_knife/__init__.py +++ b/mlx_knife/__init__.py @@ -4,7 +4,7 @@ A lightweight, ollama-like CLI for managing and running MLX models on Apple Sili Provides native MLX execution with streaming output and interactive chat capabilities. """ -__version__ = "1.0-rc3" +__version__ = "1.0.0" __author__ = "The BROKE team" __email__ = "broke@gmx.eu" __license__ = "MIT" diff --git a/mlxk-demo.gif b/mlxk-demo.gif index 0614c86..1fe53fc 100644 Binary files a/mlxk-demo.gif and b/mlxk-demo.gif differ diff --git a/mlxk-demo.tape b/mlxk-demo.tape index 53b040c..a87aa5f 100644 --- a/mlxk-demo.tape +++ b/mlxk-demo.tape @@ -22,7 +22,7 @@ Enter Sleep 1400ms # 2) start run -Type "mlxk run Mistral-7B-Instruct-v0.2-4bit" +Type "mlxk run Mistral-7B" Enter Sleep 2500ms diff --git a/pyproject.toml b/pyproject.toml index 89b4990..7766ad3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,6 +23,7 @@ classifiers = [ "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Operating System :: MacOS", + "Environment :: Console", ] dependencies = [ "huggingface-hub>=0.19.0",