Skip to content

Commit

Permalink
Fix some typos in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
pobonomo committed Nov 29, 2023
1 parent 5c5e193 commit 4e89840
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ PyTorch API

sequential

XGBoost API
***********

.. currentmodule:: gurobi_ml.xgboost

.. autosummary::
Expand Down
2 changes: 1 addition & 1 deletion src/gurobi_ml/sklearn/column_transformer.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.
# ==============================================================================

"""Module for formulating a column transformer in a :gurobipy:`gurobipy model <Model>`."""
"""Module for formulating a :external+sklearn:py:class:`sklearn.compose.ColumnTransformer` in a :gurobipy:`gurobipy model <Model>`."""

import gurobipy as gp

Expand Down
2 changes: 1 addition & 1 deletion src/gurobi_ml/sklearn/linear_regression.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.
# ==============================================================================

"""Module for inserting ordinary Scikit-Learn regression models into a
"""Module for formulating ordinary regression models into a
:gurobipy:`model`.
The following linear models are tested and should work:
Expand Down
2 changes: 1 addition & 1 deletion src/gurobi_ml/sklearn/pls_regression.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.
# ==============================================================================

"""Module for formulating simple Scikit-Learn PLS regression models in a gurobipy model."""
"""Module for formulating :external+sklearn:py:class:`sklearn.cross_decomposition.PLSRegression` in a gurobipy model."""

import numpy as np

Expand Down

0 comments on commit 4e89840

Please sign in to comment.