.. :notoc::

***********************************
Welcome to VerticaPy documentation
***********************************

.. 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>

**Date**: |today| **Latest Version**: |version|

**Useful links**:

`Source Repository <https://github.com/vertica/VerticaPy>`_ |
`Issues & Ideas <https://github.com/vertica/VerticaPy/issues>`_ |
`Q&A Support <https://github.com/vertica/VerticaPy/discussions>`_ |

:mod:`verticapy` is a Python library that provides an interface to interact with the 
Vertica database using the Python programming language. Vertica is a high-performance analytical database designed for big data analytics. VerticaPy aims to simplify data analysis and machine learning tasks by providing a Pythonic way to work with data stored in Vertica.

.. grid:: 1 2 2 3

    .. grid-item::

        .. card:: Installation Guide
          :img-top: _static/installation_guide.svg
          :link: getting_started
          :link-type: ref
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          Quick and easy guide to help you install Verticapy.

          +++
          Install VerticaPy

    .. grid-item::

        .. card:: User Guide
          :img-top: _static/user_guide.svg
          :link: user_guide
          :link-type: ref
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          The user guide offers deep insights into VerticaPy's core concepts with valuable context and explanations.

          +++
          To the User Guide!

    .. grid-item::
    
        .. card:: API Reference
          :img-top: _static/api.svg
          :link: api
          :link-type: ref
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          The API reference provides concise information about VerticaPy's functions and methods with clear examples.

          +++
          Reference Guide


    .. grid-item::
    
      .. card:: Examples
          :img-top: _static/examples.svg
          :link: ../../../examples/
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          The Examples section showcases practical use cases of VerticaPy in real-world scenarios.

          +++
          All Examples

    .. grid-item::
    
      .. card:: Contribution Guidelines
          :img-top: _static/contribution.svg
          :link: contribution_guidelines
          :link-type: ref
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          The Contribution Guidelines outline the process for actively participating in the development of VerticaPy.

          +++
          Contribute

    .. grid-item::
    
      .. card:: VerticaPy Website
          :img-top: _static/verticapy_website.svg
          :link: ../../../
          :text-align: center
          :class-card: custom-card-2
          :class-img-top: custom-class-img-top

          The official VerticaPy website showcasing our success.

          +++
          Explore

________

Customer Testimonials
^^^^^^^^^^^^^^^^^^^^^^

.. grid:: 1 1 2 2

    .. grid-item::

        .. card:: Carenne Ludeña
          :img-top: _static/website/about_us/testimonials/testi-author1.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "Using Vertica ML, we now get results in almost real-time without any wait. Our new approach [in-database machine learning using Vertica] allows for tens of millions of models being calculated over filtered aggregated data in seconds and re-written in the database for almost real-time availability. This has been a real game changer for us."

          ^^^^^^^^
          Director Data Science [Matrix Solution (Pabis Retail)]

    .. grid-item::

        .. card:: Rolando Castaños
          :img-top: _static/website/about_us/testimonials/testi-author2.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "Vertica is a data science ready database. You only have to know your business and let Vertica do the job. You don't need to be or have a data scientist, just use the out-of-the-box ML algorithms, feed data and in a matter of seconds you'll see insights, knowledge, predictions and more."

          ^^^^^^^^
          Senior Business Analyst [Axtel]

    .. grid-item::

        .. card:: Dr. Jochen Schlosser
          :img-top: _static/website/about_us/testimonials/testi-author3.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "The ML capabilities of Vertica enable us to help advertisers navigate the omnichannel world, based on scalability, relevance, and efficiency. Vertica enables us to analyze very large sets of structured and unstructured data in real time, and includes ML capabilities that help us drive our offer to both media owners and their advertisers."

          ^^^^^^^^
          Chief Strategy Officer [adform]

    .. grid-item::

        .. card:: Abhishek Sharma
          :img-top: _static/website/about_us/testimonials/testi-author4.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "Vertica’s new in-database machine learning capabilities are like gold! We are extremely excited to train our Machine Learning models on our data in Vertica and ship them with our platform to run on our customers’ clusters. This is something that is much harder with any other tool. It will improve our competitive positioning."

          ^^^^^^^^
          Data Scientist [Fidelis Cybersecurity]

    .. grid-item::

        .. card:: Bruce Yen
          :img-top: _static/website/about_us/testimonials/testi-author5.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "Vertica is crucial for enabling us to be more agile with data. Our Vertica platform is instrumental in many areas of our business—creating predictive algorithms, serving up product recommendations, powering insight to our mobile apps, and generating daily reports and ad-hoc queries."

          ^^^^^^^^
          WW Business Intelligence Leader [Guess]

    .. grid-item::

        .. card:: Stéphane Ozboyaci
          :img-top: _static/website/about_us/testimonials/testi-author6.jpg
          :text-align: center
          :class-card: custom-card-customer-test
          :class-img-top: custom-class-img-top-index-page

          "Vertica in Eon Mode and AI Capabilities Align Perfectly with our Vision. We are delighted with Vertica’s AI-driven computational capabilities and the flexibility it gives us to consolidate and visualize the data in user-friendly real-time dashboards that benefit our internal stakeholders and our customers."

          ^^^^^^^^
          Software Development Director [Unowhy]



.. toctree::
    :hidden:
    :maxdepth: 1
    :titlesonly:

    getting_started
    connection
    whats_new
    contribution_guidelines
    examples
    api
    chart_gallery
    user_guide
    user_defined_funcs
    benchmarks
    statistics
    vertica_documentation
    connectors