.. _api.machine_learning.memmodels.clusters:

==============
Clusters
==============


Base Class
-----------

.. currentmodule:: vastorbit.machine_learning.memmodel
   
.. autosummary::
   :toctree: api/

   cluster.Clustering

.. currentmodule:: vastorbit.machine_learning.memmodel.cluster

**Methods:**

.. autosummary::
   :toctree: api/

   Clustering.get_attributes
   Clustering.predict
   Clustering.predict_proba
   Clustering.predict_proba_sql
   Clustering.predict_sql
   Clustering.set_attributes
   Clustering.transform
   Clustering.transform_sql

**Attributes:**

.. autosummary::
   :toctree: api/

   Clustering.object_type

_____

K-Means
---------


.. currentmodule:: vastorbit.machine_learning.memmodel
   
.. autosummary::
   :toctree: api/

   cluster.KMeans

.. currentmodule:: vastorbit.machine_learning.memmodel.cluster

**Methods:**

.. autosummary::
   :toctree: api/

   KMeans.get_attributes
   KMeans.predict
   KMeans.predict_proba
   KMeans.predict_proba_sql
   KMeans.predict_sql
   KMeans.set_attributes
   KMeans.transform
   KMeans.transform_sql

**Attributes:**

.. autosummary::
   :toctree: api/

   KMeans.object_type


________


K-Prototypes
------------------

.. currentmodule:: vastorbit.machine_learning.memmodel
   
.. autosummary::
   :toctree: api/

   cluster.KPrototypes

.. currentmodule:: vastorbit.machine_learning.memmodel.cluster

**Methods:**

.. autosummary::
   :toctree: api/

   KPrototypes.get_attributes
   KPrototypes.predict
   KPrototypes.predict_proba
   KPrototypes.predict_proba_sql
   KPrototypes.predict_sql
   KPrototypes.set_attributes
   KPrototypes.transform
   KPrototypes.transform_sql

**Attributes:**

.. autosummary::
   :toctree: api/

   KPrototypes.object_type

_______

Bisecting K-Means
------------------

.. currentmodule:: vastorbit.machine_learning.memmodel
   
.. autosummary::
   :toctree: api/

   cluster.BisectingKMeans

.. currentmodule:: vastorbit.machine_learning.memmodel.cluster

**Methods:**

.. autosummary::
   :toctree: api/

   BisectingKMeans.get_attributes
   BisectingKMeans.plot_tree
   BisectingKMeans.predict
   BisectingKMeans.predict_proba
   BisectingKMeans.predict_proba_sql
   BisectingKMeans.predict_sql
   BisectingKMeans.set_attributes
   BisectingKMeans.to_graphviz
   BisectingKMeans.transform
   BisectingKMeans.transform_sql

**Attributes:**

.. autosummary::
   :toctree: api/

   BisectingKMeans.object_type

________

Nearest Centroid
------------------



.. currentmodule:: vastorbit.machine_learning.memmodel
   
.. autosummary::
   :toctree: api/

   cluster.NearestCentroid

.. currentmodule:: vastorbit.machine_learning.memmodel.cluster

**Methods:**

.. autosummary::
   :toctree: api/

   NearestCentroid.get_attributes
   NearestCentroid.predict
   NearestCentroid.predict_proba
   NearestCentroid.predict_proba_sql
   NearestCentroid.predict_sql
   NearestCentroid.set_attributes
   NearestCentroid.transform
   NearestCentroid.transform_sql

**Attributes:**

.. autosummary::
   :toctree: api/

   NearestCentroid.object_type