Small improvements of ReadMe (#80)

* ENH: add solvers in readme
artefactory · May 21, 2024 · f623c08 · f623c08
1 parent 6d15434
commit f623c08
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ If you are new to choice modelling, you can check this [resource](https://www.pu
 - Custom modelling is made easy by subclassing the ChoiceModel class [[Example]](notebooks/introduction/4_model_customization.ipynb)
 
 ### Auxiliary tools
-- Assortment optimization algorithms [[Example]](notebooks/auxiliary_tools/assortment_example.ipynb) [[8]](#citation)
+- Assortment & Pricing optimization algorithms [[Example]](notebooks/auxiliary_tools/assortment_example.ipynb) [[8]](#citation)
 
 ## Getting Started
 
@@ -97,13 +97,36 @@ For modelling you need:
 > :warning: **Warning:** If you are a MAC user with a M1 or M2 chip, importing TensorFlow might lead to Python crashing.
 > In such case, use anaconda to install TensorFlow with `conda install -c apple tensorflow`.
 
-Finally, an optional requirement used for coefficients analysis and L-BFGS optimization is:
+An optional requirement used for coefficients analysis and L-BFGS optimization is:
 - TensorFlow Probability (>=0.20.1)
 
+Finally for pricing or assortment optimization, you need either Gurobi or OR-Tools:
+- gurobipy (>=11.0.0)
+- ortools (>=9.6.2534)
+
 Once you have created your conda/pip python==3.9 environment, you can install requirements by:
 ```bash
 pip install choice-learn
 ```
+<p align="center">
+  <a href="https://numpy.org/">
+    <img src="docs/illustrations/logos/numpy_logo.png" width="60" />
+  </a>
+  <a href="https://pandas.pydata.org/">
+    <img src="docs/illustrations/logos/pandas_logo.png" width="60" />
+  </a>
+  <a href="https://www.tensorflow.org">
+    <img src="docs/illustrations/logos/tf_logo.png" width="60" />
+  </a>
+  <a href="https://www.gurobi.com/">
+    <img src="docs/illustrations/logos/gurobi_logo.png" width="60" />
+  </a>
+  <a href="https://developers.google.com/optimization?hl=fr">
+    <img src="docs/illustrations/logos/or_tools_logo.png" width="70" />
+  </a>
+</p>
+
+
 ## Usage
 Here is a short example of model parametrization to estimate a Conditional Logit on the SwissMetro dataset.
 

diff --git a/docs/illustrations/logos/gurobi_logo.png b/docs/illustrations/logos/gurobi_logo.png
diff --git a/docs/illustrations/logos/numpy_logo.png b/docs/illustrations/logos/numpy_logo.png
diff --git a/docs/illustrations/logos/or_tools_logo.png b/docs/illustrations/logos/or_tools_logo.png
diff --git a/docs/illustrations/logos/pandas_logo.png b/docs/illustrations/logos/pandas_logo.png
diff --git a/docs/illustrations/logos/tf_logo.png b/docs/illustrations/logos/tf_logo.png