[V1.1.0] Iteration 3 (#1329)

* [V1.1.0] Final before release. - We are making the final adjustments and then we will release the v1.1.0. * correcting kprototype example * Update __init__.py * Correcting Fortify issues SHould close: https://jira.verticacorp.com/jira/browse/VER-97398?filter=-1 * adding minimum version to QPROF * corrections multiple corrections * other changes * del image files * added pngs * fixed images in about us * fixed doc versions * Update examples.rst * Delete user_guide_performance_qprof_get_qplan_tree.PNG * Create user_guide_performance_qprof_get_qplan_tree.png * Update getting_started.rst fixed website uRL * Update qprof.py removed unnecessary note * Update user_guide_performance_qprof.rst * Update user_guide_introduction_vdf.rst * corrections * Update user_guide_introduction_vdf.rst * changing the wrong dir * added custom help function for shorter doc string view * updated whatsnew * Update qprof_interface.py --------- Co-authored-by: Umar Farooq Ghumman <[email protected]>
vertica · Oct 30, 2024 · 5c136d5 · 5c136d5
1 parent 6cf28f5
commit 5c136d5
Show file tree

Hide file tree

Showing 73 changed files with 521 additions and 461 deletions.
diff --git a/docs/source/_static/img_code_coverage_1.PNG → docs/source/_static/img_code_coverage_1.png b/docs/source/_static/img_code_coverage_1.PNG → docs/source/_static/img_code_coverage_1.png
diff --git a/docs/source/_static/img_code_coverage_2.PNG → docs/source/_static/img_code_coverage_2.png b/docs/source/_static/img_code_coverage_2.PNG → docs/source/_static/img_code_coverage_2.png
diff --git a/docs/source/_static/img_code_coverage_3.PNG → docs/source/_static/img_code_coverage_3.png b/docs/source/_static/img_code_coverage_3.PNG → docs/source/_static/img_code_coverage_3.png
diff --git a/...e/about_us/testimonials/testi-author2.png → ...e/about_us/testimonials/testi-author2.jpg b/...e/about_us/testimonials/testi-author2.png → ...e/about_us/testimonials/testi-author2.jpg
diff --git a/...uide_performance_qprof_get_qplan_tree.PNG → ...uide_performance_qprof_get_qplan_tree.png b/...uide_performance_qprof_get_qplan_tree.PNG → ...uide_performance_qprof_get_qplan_tree.png
diff --git a/docs/source/_static/whats_new_1_1_0_qprof_get_qplan_tree.png b/docs/source/_static/whats_new_1_1_0_qprof_get_qplan_tree.png
diff --git a/docs/source/about_us.rst b/docs/source/about_us.rst
@@ -206,58 +206,58 @@ Team Members
 
     .. grid-item::
 
-        .. card:: Fouad Teban
+        .. card:: Arash Fard
           :img-top: _static/website/about_us/team/member3.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
 
-          Customer Engineering
+          Senior ML Engineer
 
     .. grid-item::
 
-        .. card:: George Larionov
-          :img-top: _static/website/about_us/team/member4.jpg
+        .. card:: Fouad Teban
+          :img-top: _static/website/about_us/team/member14.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
 
-          ML Engineer & Scrum Master
+          Customer Engineering
 
     .. grid-item::
 
-        .. card:: Matteo Monaldi
-          :img-top: _static/website/about_us/team/member5.jpg
+        .. card:: George Larionov
+          :img-top: _static/website/about_us/team/member10.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
 
-          Lead Data Scientist
+          ML Engineer & Scrum Master
 
     .. grid-item::
 
-        .. card:: Abdelhak Zabour
-          :img-top: _static/website/about_us/team/member6.jpg
+        .. card:: Matteo Monaldi
+          :img-top: _static/website/about_us/team/member8.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
 
-          Data Scientist
+          Lead Data Scientist
 
     .. grid-item::
 
-        .. card:: Arash Fard
-          :img-top: _static/website/about_us/team/member7.jpg
+        .. card:: Abdelhak Zabour
+          :img-top: _static/website/about_us/team/member9.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
 
-          Senior ML Engineer
+          Data Scientist
 
     .. grid-item::
 
         .. card:: Roy Paulin
-          :img-top: _static/website/about_us/team/member8.jpg
+          :img-top: _static/website/about_us/team/member13.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -267,7 +267,7 @@ Team Members
     .. grid-item::
 
         .. card:: Xiaozhong Zhang
-          :img-top: _static/website/about_us/team/member9.jpg
+          :img-top: _static/website/about_us/team/member12.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -277,7 +277,7 @@ Team Members
     .. grid-item::
 
         .. card:: Zachary Nowak
-          :img-top: _static/website/about_us/team/member10.jpg
+          :img-top: _static/website/about_us/team/member11.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -287,7 +287,7 @@ Team Members
     .. grid-item::
 
         .. card:: Abhishek Sharma
-          :img-top: _static/website/about_us/team/member11.jpg
+          :img-top: _static/website/about_us/team/member4.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -297,7 +297,7 @@ Team Members
     .. grid-item::
 
         .. card:: Vikash Singh
-          :img-top: _static/website/about_us/team/member12.jpg
+          :img-top: _static/website/about_us/team/member5.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -307,7 +307,7 @@ Team Members
     .. grid-item::
 
         .. card:: Tyler Consigny
-          :img-top: _static/website/about_us/team/member13.jpg
+          :img-top: _static/website/about_us/team/member6.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -317,7 +317,7 @@ Team Members
     .. grid-item::
 
         .. card:: Kevin Xu
-          :img-top: _static/website/about_us/team/member14.jpg
+          :img-top: _static/website/about_us/team/member15.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card
@@ -327,7 +327,7 @@ Team Members
     .. grid-item::
 
         .. card:: Brent Eynon
-          :img-top: _static/website/about_us/team/member15.jpg
+          :img-top: _static/website/about_us/team/member7.jpg
           :link: #
           :text-align: center
           :class-card: member-pics-card

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -17,7 +17,7 @@ API Reference
         VerticaPy
     </div>
     <div style="text-align: center; font-size: 18px; font-weight: bold;">
-        Documentation 1.0.x
+        Documentation 1.1.x
     </div>
 
 

diff --git a/docs/source/cicd_codecov.rst b/docs/source/cicd_codecov.rst
@@ -21,7 +21,7 @@ For the latest statistics on code-coverage of
 ```verticapy``` please look at 
 `this link <https://app.codecov.io/gh/vertica/VerticaPy>`_.
 
-.. image:: /_static/img_code_coverage_1.PNG
+.. image:: /_static/img_code_coverage_1.png
     :width: 50%
     :align: center
 
@@ -31,7 +31,7 @@ Not only does it provide a wholistic view of the
 contributors and in-depth understanding of which 
 folders/functions are lacking behind the most. 
 
-.. image:: /_static/img_code_coverage_2.PNG
+.. image:: /_static/img_code_coverage_2.png
 
 In the details, we can see the total number of lines
 as well as the number of lines in each folder that have
@@ -42,7 +42,7 @@ at the exact lines that are missing unit tests.
 This can guide contributors in understanding the 
 gaps in testing.
 
-.. image:: /_static/img_code_coverage_3.PNG
+.. image:: /_static/img_code_coverage_3.png
 
 In summary, developers use code coverage tools to gain 
 insights into which parts of their code are well-tested 

diff --git a/docs/source/contribution_guidelines.rst b/docs/source/contribution_guidelines.rst
@@ -19,7 +19,7 @@ Contribution Guidelines
         VerticaPy
     </div>
     <div style="text-align: center; font-size: 18px; font-weight: bold;">
-        Documentation 1.0.x
+        Documentation 1.1.x
     </div>
 
 

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -48,7 +48,7 @@ Examples
         :class-card: custom-card-examples
         :class-footer: user_guide_footer
 
-        10 Nmins
+        10 Notebooks
         ^^^^^^^^^^^^^^
         Solve real-world problems with VerticaPy.
 

diff --git a/docs/source/examples_business.rst b/docs/source/examples_business.rst
@@ -23,6 +23,7 @@ Business
         optimizing base station operations. Simplify your exploration of 
         base station efficiency predictions with our user-friendly approach.
 
+    .. grid-item::
 
       .. card:: Battery
         :img-top: _static/website/examples/images/battery.jpg
@@ -39,6 +40,8 @@ Business
         overall health. Simplify your exploration of battery health 
         predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Booking
         :img-top: _static/website/examples/images/booking.jpg
         :link: examples.business.booking
@@ -54,6 +57,8 @@ Business
         into optimizing booking strategies. Simplify your exploration 
         of flight booking predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Churn
         :img-top: _static/website/examples/images/churn.jpg
         :link: examples.business.churn
@@ -69,6 +74,8 @@ Business
         retaining subscribers. Simplify your exploration of Telco 
         churn predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Credit Card Fraud
         :img-top: _static/website/examples/images/credit_card_fraud.jpg
         :link: examples.business.credit_card_fraud
@@ -86,6 +93,8 @@ Business
         Simplify your exploration of credit card fraud predictions 
         with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Football
         :img-top: _static/website/examples/images/football.jpg
         :link: examples.business.football
@@ -102,6 +111,8 @@ Business
         match results. Simplify your exploration of football outcome 
         predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Insurance
         :img-top: _static/website/examples/images/insurance.jpg
         :link: examples.business.insurance
@@ -118,6 +129,8 @@ Business
         Simplify your exploration of health insurance predictions with our 
         user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Movies
         :img-top: _static/website/examples/images/movies.jpg
         :link: examples.business.movies
@@ -134,6 +147,8 @@ Business
         into the potential success of films. Simplify your exploration 
         of movie rating predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Smart meters
         :img-top: _static/website/examples/images/smart_meters.jpg
         :link: examples.business.smart_meters
@@ -150,6 +165,8 @@ Business
         into optimizing resource efficiency. Simplify your exploration of 
         smart meter consumption predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Spam
         :img-top: _static/website/examples/images/spam.jpg
         :link: examples.business.spam
@@ -166,6 +183,8 @@ Business
         enhancing your inbox security. Simplify your exploration of 
         spam detection predictions with our user-friendly approach.
 
+    .. grid-item::
+
       .. card:: Spotify
         :img-top: _static/website/examples/images/spotify.jpg
         :link: examples.business.spotify

diff --git a/docs/source/examples_business_base_station.rst b/docs/source/examples_business_base_station.rst
@@ -40,7 +40,7 @@ This example uses the following version of VerticaPy:
 
     vp.__version__
 
-Connect to Vertica. This example uses an existing connection called "VerticaDSN." 
+Connect to Vertica. This example uses an existing connection called ``VerticaDSN``. 
 For details on how to create a connection, see the :ref:`connection` tutorial.
 You can skip the below cell if you already have an established connection.
 
@@ -402,7 +402,7 @@ Data Preparation
 Finding Clusters of Base Stations
 ++++++++++++++++++++++++++++++++++
 
-We create virtual base stations by grouping existing base stations in 100 clusters. Clustering is performed using ``k-means`` clustering on Euclidean coordinates of the base stations. Each cluster represents a wider coverage of connections.
+We create virtual base stations by grouping existing base stations in 100 clusters. Clustering is performed using :py:mod:`~verticapy.machine_learning.vertica.cluster.KMeans` clustering on Euclidean coordinates of the base stations. Each cluster represents a wider coverage of connections.
 
 .. ipython:: python
 
@@ -725,7 +725,7 @@ Let's find a suitable number of clusters using elbow curve.
 .. raw:: html
     :file: SPHINX_DIRECTORY/figures/examples_base_station_elbow_longi_lati.html
 
-The :py:func:`~verticapy.machine_learning.model_selection.elbow` curve seems to indicate that 4 would be a good number of clusters, so let's try k = 4 and view the weighted ``k-means`` algorithm's suggested positions for new base stations based on the centers of the clusters.
+The :py:func:`~verticapy.machine_learning.model_selection.elbow` curve seems to indicate that 4 would be a good number of clusters, so let's try k = 4 and view the weighted :py:mod:`~verticapy.machine_learning.vertica.cluster.KMeans` algorithm's suggested positions for new base stations based on the centers of the clusters.
 
 .. ipython:: python
     :okwarning:

diff --git a/docs/source/examples_business_battery.rst b/docs/source/examples_business_battery.rst
@@ -48,7 +48,7 @@ This example uses the following version of VerticaPy:
     import verticapy as vp
     vp.__version__
 
-Connect to Vertica. This example uses an existing connection called "VerticaDSN." 
+Connect to Vertica. This example uses an existing connection called ``VerticaDSN``. 
 For details on how to create a connection, see the :ref:`connection` tutorial.
 You can skip the below cell if you already have an established connection.
 

diff --git a/docs/source/examples_business_booking.rst b/docs/source/examples_business_booking.rst
@@ -41,7 +41,7 @@ This example uses the following version of VerticaPy:
 
     vp.__version__
 
-Connect to Vertica. This example uses an existing connection called "VerticaDSN." 
+Connect to Vertica. This example uses an existing connection called ``VerticaDSN``. 
 For details on how to create a connection, see the :ref:`connection` tutorial.
 You can skip the below cell if you already have an established connection.
 

diff --git a/docs/source/examples_business_churn.rst b/docs/source/examples_business_churn.rst
@@ -354,7 +354,7 @@ We'll use a lift chart to help us identify which of our customers are likely to
 .. raw:: html
     :file: SPHINX_DIRECTORY/figures/examples_churn_lift_chart.html
 
-By targeting less than 30% of the entire distribution, our predictions will be more than three times more accurate than the other 70%.
+By targeting less than ``30%`` of the entire distribution, our predictions will be more than three times more accurate than the other ``70%``.
 
 Conclusion
 -----------