[V1.1.0-beta] Final Corrections. (#1326)

* [V1.1.0-beta] Final Corrections. - Closing last issues and discussions. * correcting 2 bugs * 1.0 -> 1.1 links * multiple corrections - news letter removed - cheat sheet updated * Update refresh.sh * Update index.rst * doc corrections * corrections * corrections * corrections * fixed qprof image * fixed examples images * Update examples_business.rst * Update custom_styling.css added examples/business cards * updaed exampels/learn by adding details * updated examples/learn page * Update examples_learn_commodities.rst * fixed links * fixed PLSRegression example * added PLS in linear models * added QueryProfielrComaprison * fixed image gaps in about us page * Update whats_new_v1_1_0.rst * Update cluster.py --------- Co-authored-by: Umar Farooq Ghumman <[email protected]>
vertica · Oct 28, 2024 · 6cf28f5 · 6cf28f5
1 parent 0140144
commit 6cf28f5
Show file tree

Hide file tree

Showing 87 changed files with 592 additions and 431 deletions.
diff --git a/README.md b/README.md
@@ -6,20 +6,18 @@
 
 :loudspeaker: 2020-06-27: Vertica-ML-Python has been renamed to VerticaPy.
 
-:warning: The old website has been relocated to https://www.vertica.com/python/old/ and will be discontinued soon. We strongly recommend upgrading to the new major release before August 2024.
-
-:warning: The following README is for VerticaPy 1.0.x and onwards, and so some of the elements may not be present in the previous versions.
+:warning: The following README is for VerticaPy 1.1.x and onwards, and so some of the elements may not be present in the previous versions.
 
 :scroll: Some basic syntax can be found in [the cheat sheet](assets/cheat_sheet/).
 
-📰 Check out the latest newsletter [here](assets/news_letter/1.0.x/VerticaPy_Newsletter.pdf).
+📰 Check out the latest newsletter [here](https://www.vertica.com/python/documentation/1.1.x/html/whats_new.html).
 
 # VerticaPy
 
 [![PyPI version](https://badge.fury.io/py/verticapy.svg)](https://badge.fury.io/py/verticapy)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/verticapy?color=yellowgreen)](https://anaconda.org/conda-forge/verticapy)
 [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)](https://www.python.org/downloads/)
+[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/downloads/)
 [![codecov](https://codecov.io/gh/vertica/VerticaPy/branch/master/graph/badge.svg?token=a6GiFYI9at)](https://codecov.io/gh/vertica/VerticaPy)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
@@ -169,7 +167,7 @@ VerticaPy's theme-switching option ensures that users can tailor their experienc
 <br>
 
 ### SQL Magic
-You can use VerticaPy to execute SQL queries directly from a Jupyter notebook. For details, see <a href='https://www.vertica.com/python/documentation/1.0.x/html/api/verticapy.jupyter.extensions.sql_magic.sql_magic.html#verticapy.jupyter.extensions.sql_magic.sql_magic'>SQL Magic</a>:
+You can use VerticaPy to execute SQL queries directly from a Jupyter notebook. For details, see <a href='https://www.vertica.com/python/documentation/1.1.x/html/api/verticapy.jupyter.extensions.sql_magic.sql_magic.html#verticapy.jupyter.extensions.sql_magic.sql_magic'>SQL Magic</a>:
 
 #### Example
 
@@ -183,7 +181,7 @@ Execute your SQL queries.
 SELECT version();
 
 # Output
-# Vertica Analytic Database v11.0.1-0
+# Vertica Analytic Database v24.4-0
 ```
 [:arrow_up: Back to TOC](#table-of-contents)
 <br>
@@ -222,7 +220,7 @@ ON flight_vertica.ORIGIN_AIRPORT = airports.IATA_CODE;
 ```
 In the example above, the 'flight_vertica' table is stored in Vertica, whereas the 'airports' table is stored in MySQL. We can associate special symbols "&&&" to the different databases to fetch the data. The best part is that all the aggregation is pushed to the databases (i.e. it is not done in memory)!
 
-For more details on how to setup DBLINK, please visit the [github repo](https://github.com/vertica/dblink). To learn about using DBLINK in VerticaPy, check out the [documentation page](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/full_stack/dblink_integration/).
+For more details on how to setup DBLINK, please visit the [github repo](https://github.com/vertica/dblink). To learn about using DBLINK in VerticaPy, check out the [documentation page](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/full_stack/dblink_integration/).
 
 [:arrow_up: Back to TOC](#table-of-contents)
 <br>
@@ -262,7 +260,7 @@ https://www.vertica.com/python/documentation/chart.html
 
 - **Data Ingestion**
 
-  VerticaPy allows users to ingest data from a diverse range of sources, such as AVRO, Parquet, CSV, JSON etc. With a simple command "[read_file](https://www.vertica.com/python/documentation/1.0.x/html/api/verticapy.read_file.html)", VerticaPy automatically infers the source type and the data type.
+  VerticaPy allows users to ingest data from a diverse range of sources, such as AVRO, Parquet, CSV, JSON etc. With a simple command "[read_file](https://www.vertica.com/python/documentation/1.1.x/html/api/verticapy.read_file.html)", VerticaPy automatically infers the source type and the data type.
 
   ```python
   import verticapy as vp
@@ -325,7 +323,7 @@ We can even see the SQL underneath every VerticaPy command by turning on the gen
      PARSER FJsonParser()
 ```
 
-VerticaPy provides functions for importing other specific file types, such as [read_json](#https://www.vertica.com/python/documentation/1.0.x/html/api/verticapy.read_json.html#verticapy.read_json) and [read_csv](#https://www.vertica.com/python/documentation/1.0.x/html/api/verticapy.read_csv.html). Since these functions focus on a particular file type, they offer more options for tackling the data. For example, [read_json](#https://www.vertica.com/python/documentation/1.0.x/html/api/verticapy.read_json.html#verticapy.read_json) has a "flatten_arrays" parameter that allows you to flatten nested JSON arrays.
+VerticaPy provides functions for importing other specific file types, such as [read_json](#https://www.vertica.com/python/documentation/1.1.x/html/api/verticapy.read_json.html#verticapy.read_json) and [read_csv](#https://www.vertica.com/python/documentation/1.1.x/html/api/verticapy.read_csv.html). Since these functions focus on a particular file type, they offer more options for tackling the data. For example, [read_json](#https://www.vertica.com/python/documentation/1.1.x/html/api/verticapy.read_json.html#verticapy.read_json) has a "flatten_arrays" parameter that allows you to flatten nested JSON arrays.
 
 - **Data Exploration**
 
@@ -396,7 +394,7 @@ titanic.corr(method="spearman", focus="survived")
 
 - **Data Preparation**
 
-  Whether you are [joining multiple tables](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/data_prep/joins/), [encoding](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/data_prep/encoding/), or [filling missing values](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/data_prep/missing_values/), VerticaPy has everything and more in one package.
+  Whether you are [joining multiple tables](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/data_prep/joins/), [encoding](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/data_prep/encoding/), or [filling missing values](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/data_prep/missing_values/), VerticaPy has everything and more in one package.
 
 ```python
 import random
@@ -413,7 +411,7 @@ data.outliers_plot(columns="Heights")
 
 - **Machine Learning**
 
-  ML is the strongest suite of VerticaPy as it capitalizes on the speed of in-database training and prediction by using SQL in the background to interact with the database. ML for VerticaPy covers a vast array of tools, including [time series forecasting](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/ml/time_series/), [clustering](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/ml/clustering/), and [classification](https://www.vertica.com/python/documentation/1.0.x/html/notebooks/ml/classification/). 
+  ML is the strongest suite of VerticaPy as it capitalizes on the speed of in-database training and prediction by using SQL in the background to interact with the database. ML for VerticaPy covers a vast array of tools, including [time series forecasting](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/ml/time_series/), [clustering](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/ml/clustering/), and [classification](https://www.vertica.com/python/documentation/1.1.x/html/notebooks/ml/classification/). 
 
 ```python
 # titanic_vd is already loaded
@@ -596,7 +594,7 @@ Enjoy!
 
 ### Contributing
 
-For a short guide on contribution standards, see the <a href='https://www.vertica.com/python/documentation/1.0.x/html/contribution_guidelines.html'>Contribution Guidelines</a>.
+For a short guide on contribution standards, see the <a href='https://www.vertica.com/python/documentation/1.1.x/html/contribution_guidelines.html'>Contribution Guidelines</a>.
 
 ### Communication
 

diff --git a/assets/cheat_sheet/1.0.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_0.docx b/assets/cheat_sheet/1.0.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_0.docx
diff --git a/...Py_Machine_Learning_Cheat_Sheet_1_0_1.pdf → ...caPy_Machine_Learning_Cheat_Sheet_1_0.pdf b/...Py_Machine_Learning_Cheat_Sheet_1_0_1.pdf → ...caPy_Machine_Learning_Cheat_Sheet_1_0.pdf
diff --git a/assets/cheat_sheet/1.0.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_0_1.docx b/assets/cheat_sheet/1.0.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_0_1.docx
diff --git a/assets/cheat_sheet/1.1.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_1.docx b/assets/cheat_sheet/1.1.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_1.docx
diff --git a/assets/cheat_sheet/1.1.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_1.pdf b/assets/cheat_sheet/1.1.x/VerticaPy_Machine_Learning_Cheat_Sheet_1_1.pdf
diff --git a/assets/news_letter/1.0.x/VerticaPy_Newsletter.md b/assets/news_letter/1.0.x/VerticaPy_Newsletter.md
diff --git a/assets/news_letter/1.0.x/VerticaPy_Newsletter.pdf b/assets/news_letter/1.0.x/VerticaPy_Newsletter.pdf
diff --git a/docs/refresh.sh b/docs/refresh.sh
@@ -25,7 +25,7 @@ make html
 python3 remove_pattern.py
 
 # Fix search directory for top nav bar + logo
-python3 fix_links
+python3 fix_links.py
 
 # Create Manual TOC tree
 python3 create_toc_tree.py

diff --git a/docs/source/_static/css/custom_styling.css b/docs/source/_static/css/custom_styling.css
@@ -556,6 +556,32 @@ body {
   height: 520px; /* Adjust the desired height */
 }
 
+/* Cards on Examples Page */
+.custom-class-img-top-examples {
+  height: 280px;
+}
+.custom-card-examples{
+  height: 420px;
+}
+/* Cards on Examples/Business Page */
+.custom-card-examples-business{
+  height: 500px;
+  border-bottom-left-radius: 20px;
+  border-bottom-right-radius: 20px;
+}
+/* Cards on Examples/Learn Page */
+.custom-card-examples-learn{
+  height: 500px;
+  border-bottom-left-radius: 20px;
+  border-bottom-right-radius: 20px;
+}
+/* Cards on Examples/understand Page */
+.custom-card-examples-understand{
+  height: 550px;
+  border-bottom-left-radius: 20px;
+  border-bottom-right-radius: 20px;
+}
+
 
 /* Cards on Machine Learning page */
 .custom-card-3 {

diff --git a/docs/source/_static/website/about_us/testimonials/testi-author2.jpg b/docs/source/_static/website/about_us/testimonials/testi-author2.jpg
diff --git a/docs/source/_static/website/about_us/testimonials/testi-author2.png b/docs/source/_static/website/about_us/testimonials/testi-author2.png
diff --git a/docs/source/_static/website/examples/images/learn.jpg b/docs/source/_static/website/examples/images/learn.jpg
diff --git a/docs/source/_static/website/examples/images/understand.jpg b/docs/source/_static/website/examples/images/understand.jpg
diff --git a/docs/source/about_us.rst b/docs/source/about_us.rst
@@ -13,10 +13,17 @@ Elevate Your Analytics Journey with VerticaPy's Expertise
 
 .. tab:: In-Database
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
+
     .. image:: ../../docs/source/_static/website/about_us/opentext-network-database-share-ico-48.svg
         :width: 10%
         :align: center
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
 
     VerticaPy Harnesses the Power of Vertica.
 
@@ -32,10 +39,17 @@ Elevate Your Analytics Journey with VerticaPy's Expertise
 
 .. tab:: Ease of Use
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
+
     .. image:: ../../docs/source/_static/website/about_us/opentext-process-maze-ico-48.svg
         :width: 10%
         :align: center
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
 
     Seamless Learning Experience: VerticaPy's Familiarity akin to sklearn and pandas.
 
@@ -51,10 +65,17 @@ Elevate Your Analytics Journey with VerticaPy's Expertise
 
 .. tab:: Advanced Analytics
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
+
     .. image:: ../../docs/source/_static/website/about_us/opentext-ai-ai-ico-48.svg
         :width: 10%
         :align: center
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
 
     Advanced Analytics Elevated: Exploring the Realm of VerticaPy.
 
@@ -70,10 +91,17 @@ Elevate Your Analytics Journey with VerticaPy's Expertise
 
 .. tab:: Dynamic Visualizations
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
+
     .. image:: ../../docs/source/_static/website/about_us/opentext-performance-chart-line-bar-noaxis-ico-48.svg
         :width: 10%
         :align: center
 
+    .. raw:: html
+
+        <div style="height: 20px;"></div>
 
     Visualize Insights with Precision: Unleash the Power of VerticaPy Charts
 

diff --git a/docs/source/benchmarks_xgboost.rst b/docs/source/benchmarks_xgboost.rst
@@ -10,7 +10,7 @@ Vertica vs Amazon Redshift | Python | PySpark
 
 .. important::
 
-  |  *Version Details*
+  |  **Version Details**
   |  **Vertica:** 23.4
   |  **Amazon Redshift:** Jan 2023
   |  **Amazon Sagemaker:** Jan 2023
@@ -594,7 +594,7 @@ The comparison analysis on both datasets follows:
 
 
 
-.. tab:: Amazon dataset analysis
+.. tab:: ``amazon`` dataset analysis
 
 
   Below are the results from different experiments of parameters. 

diff --git a/docs/source/contribution_guidelines.rst b/docs/source/contribution_guidelines.rst
@@ -33,14 +33,11 @@ This document will guide you through the contribution process. For code contribu
   contribution_guidelines_code
   tolerance
 
-
 Some other options are:
 
 - Bug Reports
 - Feature Requests
 
-
-
 Bug Reports
 ------------
 
@@ -55,4 +52,4 @@ Feel free to share your ideas for how to improve *VerticaPy*. We're always open
 You can open an `issue <https://github.com/vertica/VerticaPy/issues>`_
 with details describing what feature(s) you'd like to be added or changed.
 
-If you would like to implement the feature yourself, open an issue to ask before working on it. Once approved, please refer to :ref:`contribution_guidelines.code`.
+If you would like to implement the feature yourself, open an issue to ask before working on it. Once approved, please refer to :ref:`contribution_guidelines.code` .
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -13,8 +13,9 @@ Examples
         :link: examples.learn
         :link-type: ref
         :img-top: _static/website/examples/images/learn.jpg
+        :class-img-top: custom-class-img-top-examples
         :text-align: center
-        :class-card: custom-card-8
+        :class-card: custom-card-examples
         :class-footer: user_guide_footer
 
         5 Notebooks
@@ -26,9 +27,10 @@ Examples
       .. card:: Understand
         :link: examples.understand
         :img-top: _static/website/examples/images/understand.jpg
+        :class-img-top: custom-class-img-top-examples
         :link-type: ref
         :text-align: center
-        :class-card: custom-card-8
+        :class-card: custom-card-examples
         :class-footer: user_guide_footer
 
         3 Notebooks
@@ -41,13 +43,14 @@ Examples
         :link: examples.business
         :link-type: ref
         :img-top: _static/website/examples/images/business.jpg
+        :class-img-top: custom-class-img-top-examples
         :text-align: center
-        :class-card: custom-card-8
+        :class-card: custom-card-examples
         :class-footer: user_guide_footer
 
         10 Nmins
         ^^^^^^^^^^^^^^
-        Details...
+        Solve real-world problems with VerticaPy.