diff --git a/README.md b/README.md index 2ed1d8f..8b8e657 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # OptimizR 🚀

- OptimizR Logo + OptimizR Logo

**High-performance optimization algorithms in Rust with Python bindings** diff --git a/docs/source/conf.py b/docs/source/conf.py index 18b3ac1..4a01a3d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,8 +34,8 @@ html_theme = 'furo' # Modern, clean theme html_static_path = ['_static'] html_title = 'OptimizR Documentation' html_short_title = 'OptimizR' -html_logo = 'logo_optimizr_valid.png' -html_favicon = 'logo_optimizr_valid.png' +html_logo = 'logo_optimizrs.png' +html_favicon = 'logo_optimizrs.png' html_theme_options = { "light_css_variables": { diff --git a/docs/source/examples.md b/docs/source/examples.md index 0dff798..601b14d 100644 --- a/docs/source/examples.md +++ b/docs/source/examples.md @@ -108,17 +108,15 @@ print("Half-life:", estimate_half_life_py(returns)) ## Notebooks -Explore interactive tutorials on GitHub: - -- **Differential Evolution**: [`03_differential_evolution_tutorial.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/03_differential_evolution_tutorial.ipynb) -- **Mean Field Games**: [`mean_field_games_tutorial.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/mean_field_games_tutorial.ipynb) -- **HMM**: [`01_hmm_tutorial.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/01_hmm_tutorial.ipynb) -- **MCMC**: [`02_mcmc_tutorial.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/02_mcmc_tutorial.ipynb) -- **Optimal Control & Kalman**: [`03_optimal_control_tutorial.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/03_optimal_control_tutorial.ipynb) -- **Performance Benchmarks**: [`05_performance_benchmarks.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/05_performance_benchmarks.ipynb) +- Differential Evolution: `examples/notebooks/03_differential_evolution_tutorial.ipynb` +- Mean Field Games: `examples/notebooks/mean_field_games_tutorial.ipynb` +- HMM: `examples/notebooks/01_hmm_tutorial.ipynb` +- MCMC: `examples/notebooks/02_mcmc_tutorial.ipynb` +- Optimal Control & Kalman: `examples/notebooks/03_optimal_control_tutorial.ipynb` +- Performance benchmarks: `examples/notebooks/05_performance_benchmarks.ipynb` ## Contribute Examples -1. Fork the [repository](https://github.com/ThotDjehuty/optimiz-r) and add notebooks under `examples/notebooks/` +1. Fork the repository and add notebooks under `examples/notebooks/` 2. Keep dependencies minimal (NumPy/Matplotlib preferred) 3. Ensure the notebook runs end-to-end before submitting a PR diff --git a/docs/source/logo_optimizr_valid.jpeg b/docs/source/logo_optimizr_valid.jpeg deleted file mode 100644 index 449c323..0000000 Binary files a/docs/source/logo_optimizr_valid.jpeg and /dev/null differ diff --git a/docs/source/logo_optimizr_valid.png b/docs/source/logo_optimizr_valid.png deleted file mode 100644 index 8b5f2a1..0000000 Binary files a/docs/source/logo_optimizr_valid.png and /dev/null differ diff --git a/docs/source/logo_optimizrs.png b/docs/source/logo_optimizrs.png new file mode 100644 index 0000000..b40a39b Binary files /dev/null and b/docs/source/logo_optimizrs.png differ