Skip to content

Docstring Fix - Added Contour Plot #763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion verticapy/machine_learning/vertica/ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 +697,21 @@ class RandomForestRegressor(Regressor, RandomForest):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Model Register
^^^^^^^^^^^^^^

Expand Down Expand Up @@ -1503,6 +1518,21 @@ class RandomForestClassifier(MulticlassClassifier, RandomForest):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -2153,7 +2183,7 @@ class IsolationForest(Clustering, Tree):
exploring predictions and gaining a deeper understanding of how
these models perform in different scenarios. Please refer to
:ref:`chart_gallery.contour_plot` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
62 changes: 61 additions & 1 deletion verticapy/machine_learning/vertica/linear_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ class ElasticNet(Regressor, LinearModel):
in training the model. Note that setting
fit_intercept to false does not work well with
the BFGS optimizer.

Examples
---------

Expand Down Expand Up @@ -1026,6 +1026,21 @@ class Lasso(Regressor, LinearModel):
The plotting feature is typically suitable for models with fewer than
three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -1472,6 +1487,21 @@ class LinearRegression(Regressor, LinearModel):
The plotting feature is typically suitable for models with fewer
than three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -1920,6 +1950,21 @@ class Ridge(Regressor, LinearModel):
The plotting feature is typically suitable for models with fewer than
three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -2497,6 +2542,21 @@ class LogisticRegression(BinaryClassifier, LinearModelClassifier):
The plotting feature is typically suitable for models with
fewer than three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
30 changes: 30 additions & 0 deletions verticapy/machine_learning/vertica/svm.py
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,21 @@ class LinearSVR(Regressor, LinearModel):
The plotting feature is typically suitable for models with fewer than
three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -970,6 +985,21 @@ class LinearSVC(BinaryClassifier, LinearModelClassifier):
The plotting feature is typically suitable for models with
fewer than three predictors.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
60 changes: 60 additions & 0 deletions verticapy/machine_learning/vertica/tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,21 @@ class DecisionTreeRegressor(RandomForestRegressor):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Model Register
^^^^^^^^^^^^^^

Expand Down Expand Up @@ -738,6 +753,21 @@ class DummyTreeRegressor(RandomForestRegressor):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Model Register
^^^^^^^^^^^^^^

Expand Down Expand Up @@ -1282,6 +1312,21 @@ class DecisionTreeClassifier(RandomForestClassifier):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Parameter Modification
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -1813,6 +1858,21 @@ class DummyTreeClassifier(RandomForestClassifier):
of the huge size of the tree. But it should render nicely
in jupyter environment.

**Contour plot** is another useful plot that can be produced
for models with two predictors.

.. code-block:: python

model.contour()

.. important::

Machine learning models with two predictors can usually
benefit from their own contour plot. This visual representation
aids in exploring predictions and gaining a deeper understanding
of how these models perform in different scenarios.
Please refer to :ref:`chart_gallery.contour` for more examples.

Model Register
^^^^^^^^^^^^^^

Expand Down