.. _api:

=============
API Reference
=============

.. raw:: html

   <div style="text-align: center;">
     <a href="../../..">
       <img src="_static/vp_logo.png" alt="Clickable Image" style="width: 20%;">
     </a>
   </div>
.. raw:: html

    <div style="text-align: center; font-size: 26px; font-family: 'Inter', sans-serif; padding-top: 10px;">
        VerticaPy
    </div>
    <div style="text-align: center; font-size: 18px; font-weight: bold;">
        Documentation 1.1.x
    </div>


This page gives an overview of all public verticapy objects, functions and
methods. 


.. grid:: 2

    .. grid-item::
    
      .. card:: Connection
          :link: api.connect
          :link-type: ref
          :text-align: center
          :class-card: custom-card
          :class-footer: user_guide_footer

          
          ^^^^^^^^
          View/Modify Database Connections. 

    .. grid-item::
    
      .. card:: Parsers
          :link: api.parsers
          :link-type: ref
          :text-align: center
          :class-card: custom-card
          :class-footer: user_guide_footer

          
          ^^^^^^^^
          Different methods to ingest data.


    .. grid-item::
    
      .. card:: vDataFrame
          :link: api.vdataframe
          :link-type: ref
          :text-align: center
          :class-card: custom-card
          :class-footer: user_guide_footer

          
          ^^^^^^^^
          vDataFrame is the main object of VerticaPy.


    .. grid-item::

        .. card:: Machine Learning
          :link: api.machine_learning
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Create and Optimize ML models.

    .. grid-item::
    
      .. card:: SDK-Vertica
          :link: api.sdk-vertica
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^^
          User Defined Functions.

    .. grid-item::
    
      .. card:: SQL
          :link: api.sql
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^^
          Using SQL.

    .. grid-item::

      .. card:: Performance
          :link: api.performance
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Performance metrics.

    .. grid-item::
    
      .. card:: Stats
          :link: api.stats
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^
          Statistical Functions.

    .. grid-item::
    
      .. card:: Utilities
          :link: api.utilities
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Ingest, Read, & Drop Data.
  
    
    .. grid-item::

      .. card:: Datasets
          :link: api.datasets
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Titanic, Iris, Amazon.


    .. grid-item::

      .. card:: Plotting
          :link: api.plotting
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Charts & Graphs.


    .. grid-item::

      .. card:: Jupyter Extensions
          :link: api.jupyter
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          Charts & Magic SQL.

    .. grid-item::

      .. card:: TableSample
          :link: api.tablesample
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^^
          TableSample Object.


    .. grid-item::

      .. card:: Error handling
          :link: api.error
          :link-type: ref
          :text-align: center
          :class-card: custom-card

          ^^^^^^^^
          All the types of errors.

---------

.. toctree::
  :maxdepth: 2
  :hidden:
  
  connect
  datasets
  error
  jupyter
  machine_learning
  parsers
  performance
  plotting
  sdk-vertica
  sql
  stats
  tablesample
  utilities
  vdataframe