gavindiaz/optimiz-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Rebrand OptimizR to Optimiz-rs throughout documentation

Browse Source 
Updated Branding in ReadTheDocs:
- ✅ All 'OptimizR' → 'Optimiz-rs' (17 files)
- ✅ Project name in conf.py
- ✅ HTML title and short title
- ✅ All algorithm documentation
- ✅ Getting started guide
- ✅ Installation guide
- ✅ Theory/mathematical foundations
- ✅ Archive documentation

Documentation now consistently uses the new 'optimiz-rs' branding that
matches both PyPI and crates.io package names.

Note: Python module name 'optimizr' in import statements intentionally
unchanged (that's the actual module name).
This commit is contained in:
ThotDjehuty
2026-02-17 10:09:15 +01:00
parent bfd0d3c591
commit b10263b4f2
17 changed files with 63 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/archive/PROJECT_SUMMARY.md
+6 -6
View File
@@ -1,8 +1,8 @@
# OptimizR Project Summary
# Optimiz-rs Project Summary
## What is OptimizR?
## What is Optimiz-rs?
OptimizR is a **general-purpose optimization library** that provides high-performance implementations of advanced algorithms in Rust with easy-to-use Python bindings. It's designed to be fast, reliable, and production-ready for open-source distribution.
Optimiz-rs is a **general-purpose optimization library** that provides high-performance implementations of advanced algorithms in Rust with easy-to-use Python bindings. It's designed to be fast, reliable, and production-ready for open-source distribution.
## Key Features
@@ -140,7 +140,7 @@ x_opt, f_min = differential_evolution(
## Differences from rust-hft-arbitrage-lab
| Aspect | rust-hft-arbitrage-lab | OptimizR |
| Aspect | rust-hft-arbitrage-lab | Optimiz-rs |
|--------|----------------------|----------|
| **Purpose** | HFT trading strategies | General optimization library |
| **Scope** | Trading-specific | Domain-agnostic |
@@ -165,7 +165,7 @@ x_opt, f_min = differential_evolution(
```bash
git init
git add .
git commit -m "Initial commit: OptimizR v0.1.0"
git commit -m "Initial commit: Optimiz-rs v0.1.0"
git remote add origin https://github.com/ThotDjehuty/optimiz-r.git
git push -u origin main
```
@@ -217,7 +217,7 @@ Based on benchmarks from rust-hft-arbitrage-lab:
## Marketing/Outreach
1. **Reddit**: r/rust, r/python, r/MachineLearning
2. **Hacker News**: "Show HN: OptimizR - Fast optimization algorithms in Rust"
2. **Hacker News**: "Show HN: Optimiz-rs - Fast optimization algorithms in Rust"
3. **Twitter/X**: Tweet with #rustlang #python
4. **PyPI**: Ensure good package description
5. **GitHub Topics**: optimization, rust, python, scientific-computing