(c) 2025 + many corrections

Author: oualib

.gitignore

@@ -1,4 +1,4 @@
-# Copyright  (c)  2018-2024 Open Text  or  one  of its
+# Copyright  (c)  2018-2025 Open Text  or  one  of its
 # affiliates.  Licensed  under  the   Apache  License,
 # Version 2.0 (the  "License"); You  may  not use this
 # file except in compliance with the License.

docs/source/conf.py

@@ -199,7 +199,7 @@
 
 
 project = "VerticaPy"
-copyright = "2023-2024 OpenText. All rights reserved."
+copyright = "2023-2025 OpenText. All rights reserved."
 author = "Vertica"
 release = "1.1.x"
 # -- General configuration ---------------------------------------------------

docs/source/contribution_guidelines_code_auto_doc.rst

@@ -351,7 +351,7 @@ Code blocks can be added using the code-clock directive. Always remember to leav
 
 Code execution
 
-In order to execute and display certain, we can use the ipython directive. Note that you will have to install and import the two extensions inside the conf file while using with sphinx: IPython.sphinxext.ipython_directive, IPython.sphinxext.ipython_console_highlighting
+In order to execute and display certain, we can use the ipython directive. Note that you will have to install and import the two extensions inside the conf file while using with sphinx: ``IPython.sphinxext.ipython_directive`` , IPython.sphinxext.ipython_console_highlighting
 
 To execute and display line of code use the following syntax:
 
@@ -416,7 +416,7 @@ Code block with Suppressed code
         print(vpp.vDataFrame({"a":[1,2,3]}))
 
 
-Though both examples produce the same result but there are suggested use-cases for each. In cases where you have to import a lot of supporting libraries you can use the directive method, and in cases where you only need to skip one line, then pseudo-directive (@suppress) is preferred.
+Though both examples produce the same result but there are suggested use-cases for each. In cases where you have to import a lot of supporting libraries you can use the directive method, and in cases where you only need to skip one line, then pseudo-directive ( ``@suppress`` ) is preferred.
 
 
 Plotting Using matplotlib
@@ -497,7 +497,7 @@ Plotting VerticaPy plot
 Advanced Output
 ----------------
 
-If we want to produce advanced output like the VerticaPy vDataFrame output or some other advanced graphics then we can use the following methodology:
+If we want to produce advanced output like the VerticaPy :py:mod:`~verticapy.vDataFrame` output or some other advanced graphics then we can use the following methodology:
 
 (1) Create the html representation of the image
 

docs/source/contribution_guidelines_code_auto_doc_render.rst

@@ -4,9 +4,6 @@
 Render your doc-string
 =======================
 
-
-
-
 You can either use the `sphinx documentation page <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ 
 to setup sphinx in your system. Or you can follow the below simple steps that give you the opportunity to test just one specific file. 
 
@@ -38,9 +35,9 @@ Build the html pages by running the below command while inside the docs director
 
     make html
 
-Once the build is complete, you can navigate to the build/html directory. There open the index.html in any browser to view your resulting documentation page.
+Once the build is complete, you can navigate to the ``build/html`` directory. There open the index.html in any browser to view your resulting documentation page.
 
-If you want to make changes then make changes to your test_file.py and then clean the files using:
+If you want to make changes then make changes to your ``test_file.py`` and then clean the files using:
 .. code-block:: shell
     
     make clean

docs/source/contribution_guidelines_code_example.rst

@@ -6,14 +6,14 @@ Example
 
 
 
-The vDataFrame a powerful Python object that lies at the heart of VerticaPy. vDataFrames consist of vColumn objects that represent columns in the dataset.
+The vDataFrame a powerful Python object that lies at the heart of VerticaPy. :py:mod:`~verticapy.vDataFrame` consist of :py:mod:`~verticapy.vDataColumn` objects that represent columns in the dataset.
 
-You can find all vDataFrame's methods inside the folder verticapy/core/vdataframe. Note that similar methods have been clubbed together inside one module/file. For examples, all methods pertaining to aggregates are in the '_aggregate.py' file.
+You can find all :py:mod:`~verticapy.vDataFrame` methods inside the folder ``verticapy/core/vdataframe`` . Note that similar methods have been clubbed together inside one module/file. For examples, all methods pertaining to aggregates are in the ``_aggregate.py`` file.
 
 
-You can define any new vDataFrame method inside these modules depending on the nature of the method. The same applies to vColumns. You can use any of the developed classes to inherit properties.
+You can define any new :py:mod:`~verticapy.vDataFrame` method inside these modules depending on the nature of the method. The same applies to :py:mod:`~verticapy.vDataColumn` . You can use any of the developed classes to inherit properties.
 
-When defining a function, you should specify the 'type' hints for every variable: 
+When defining a function, you should specify the ``type`` hints for every variable: 
 
 - For variables of multiple types, use the Union operator.
 - For variables that are optional, use the Optional operator. 
@@ -47,14 +47,14 @@ Be sure to write a detailed description for each function that explains how it w
         ----------
         columns: SQLColumns
             List of the vDataColumns names.
-        max_cardinality: int / tuple, optional
+        max_cardinality: int | tuple, optional
             Maximum number of distinct elements for
             vDataColumns 1  and  2  to be used as
             categorical. For these elements, no  h
             is picked or computed.
             If  of type tuple, represents the
             'max_cardinality' of each column.
-        h: int / tuple, optional
+        h: int | tuple, optional
             Interval  width  of the bar. If empty,  an
             optimized h will be computed.
             If  of type tuple, it must represent  each
@@ -78,31 +78,31 @@ Important: the vDataFrame.get_columns() and vDataFrame.format_colnames() functio
 
 
 
-Use the \_genSQL method to get the current vDataFrame relation.
+Use the :py:func:`~verticapy.vDataFrame.current_relation` method to get the current :py:mod:`~verticapy.vDataFrame` relation.
 
 .. ipython:: python
     
-    titanic._genSQL()
+    titanic.current_relation()
 
 
-And the \_executeSQL\_ function to execute a SQL query.
+And the ``_executeSQL`` function to execute a SQL query.
 
 .. ipython:: python
 
     from verticapy._utils._sql._sys import _executeSQL
     _executeSQL(f"SELECT * FROM {titanic._genSQL()} LIMIT 2")
 
 
-The result of the query is accessible using one of the methods of the 'executeSQL' parameter.
+The result of the query is accessible using one of the methods of the ``_executeSQL`` parameter.
 
 .. ipython:: python
 
     _executeSQL(f"SELECT * FROM {titanic._genSQL()} LIMIT 2",method="fetchall")
 
 
-The @save_verticapy_logs decorator saves information about a specified VerticaPy method to the QUERY_PROFILES table in the Vertica database. You can use this to collect usage statistics on methods and their parameters.
+The ``@save_verticapy_logs`` decorator saves information about a specified VerticaPy method to the ``QUERY_PROFILES`` table in the Vertica database. You can use this to collect usage statistics on methods and their parameters.
 
-For example, to create a method to compute the correlations between two vDataFrame columns:
+For example, to create a method to compute the correlations between two :py:mod:`~verticapy.vDataFrame` columns:
 
 .. code-block:: python
 
@@ -114,14 +114,14 @@ For example, to create a method to compute the correlations between two vDataFra
         # Describe the function
         """
         ---------------------------------------------------------------------------
-        Computes the Pearson Correlation Coefficient of the two input vColumns. 
+        Computes the Pearson Correlation Coefficient of the two input vDataColumns. 
 
         Parameters
         ----------
         column1: str
-            Input vColumn.
+            Input vDataColumn.
         column2: str
-            Input vColumn.
+            Input vDataColumn.
 
         Returns
         -------
@@ -146,25 +146,25 @@ For example, to create a method to compute the correlations between two vDataFra
         # Return the result
         return result
 
-Same can be done with vColumn methods.
+Same can be done with :py:mod:`~verticapy.vDataColumn` methods.
 
 .. code-block:: python
 
-    # Example Method for a vColumn
+    # Example Method for a vDataColumn
 
     # Add types hints + @save_verticapy_logs decorator
     @save_verticapy_logs
     def pearson(self, column: str,):
         # Describe the function
         """
         ---------------------------------------------------------------------------
-        Computes the Pearson Correlation Coefficient of the vColumn and the input 
-        vColumn. 
+        Computes the Pearson Correlation Coefficient of the vDataColumn and the input 
+        vDataColumn. 
 
         Parameters
         ----------
         column: str
-            Input vColumn.
+            Input vDataColumn.
 
         Returns
         -------
@@ -177,18 +177,17 @@ Same can be done with vColumn methods.
             """
         # Format the column
         column1 = self.parent.format_colnames([column])[0]
-        # Get the current vColumn name
+        # Get the current vDataColumn name
         column2 = self.alias
         # Get the current vDataFrame relation
         table = self.parent._genSQL()
         # Create the SQL statement - Label the query when possible
-        query = f"SELECT /*+LABEL(vColumn.pearson)*/ CORR({column1}, {column2}) FROM {table};"
+        query = f"SELECT /*+LABEL(vDataColumn.pearson)*/ CORR({column1}, {column2}) FROM {table};"
         # Execute the SQL query and get the result
         result = executeSQL(query, 
                             title = "Computing Pearson coefficient", 
                             method="fetchfirstelem")
         # Return the result
         return result
 
-
-Functions will work exactly the same.
+Functions will work exactly the same.

docs/source/contribution_guidelines_code_misc.rst

@@ -22,7 +22,7 @@ Every file in this project must use the following Apache 2.0 header (with the ap
 .. code-block:: python
 
     """
-    Copyright  (c)  2018-2023 Open Text  or  one  of its
+    Copyright  (c)  2018-2025 Open Text  or  one  of its
     affiliates.  Licensed  under  the   Apache  License,
     Version 2.0 (the  "License"); You  may  not use this
     file except in compliance with the License.

docs/source/whats_new_v1_1_0.rst

@@ -4,16 +4,15 @@
 Version 1.1.0
 ===============
 
-This release encompasses all the features introduced in 1.0.0 (see :ref:`whats_new_v1_0_0`) 
-and introduces additional functionalities along with more precise docstrings.
+This release encompasses all the features introduced in ``1.0.0`` (see :ref:`whats_new_v1_0_0`) and introduces additional functionalities along with more precise docstrings.
 
 Options
 --------
 
 :py:func:`~verticapy.set_option` function has more options:
   - ``max_cellwidth``: Maximum width of any VerticaPy table's cell.
   - ``max_tableheight``: Maximum height of VerticaPy tables.
-  - ``theme``: Theme used to display the VerticaPy objects ('light', 'dark' or 'sphinx').
+  - ``theme``: Theme used to display the VerticaPy objects (``light``, ``dark`` or ``sphinx``).
   - ``verbosity``: This will set the amount of information to display while executing VerticaPy functions.
 
 .. note::
@@ -35,9 +34,7 @@ PLS Regression
 
 Partial Least Squares (PLS) regression has been added to VerticaPy. 
 
-This integration will enhance VerticaPy's analytics capabilities, 
-particularly benefiting Vertica customers who have expressed interest 
-in utilizing PLS regression.
+This integration will enhance VerticaPy's analytics capabilities, particularly benefiting Vertica customers who have expressed interest in utilizing PLS regression.
 
 For more details, please look at 
 :py:mod:`~verticapy.machine_learning.vertica.linear_model.PLSRegression`
@@ -62,59 +59,57 @@ Example use:
 
 .. note:: 
 
-  All the ML models that were introduced in version 1.0.x are also supported in version 1.1.x.
+  All the ML models that were introduced in version ``1.0.x`` are also supported in version ``1.1.x`` .
 ___________
 
 Performance
 ------------
 
-``QueryProfiler`` has been greatly supplemented in this release: 
+:py:class:`~verticapy.performance.vertica.qprof.QueryProfiler` has been greatly supplemented in this release: 
 
 QueryProfilerInterface
 +++++++++++++++++++++++
 
 Now we have added the functionality of a ``session_control_param`` parameter.
 This allows users to enter the alter session SQL before profiling the queries.
 
-
 QueryProfilerInterface
 +++++++++++++++++++++++
 
- 
 - Added many more metrics for the profiled queries such as:
 
-  - rows_filtered_sip
-  - container_rows_filtered_sip
-  - container_rows_pruned_sip
+  - ``rows_filtered_sip``
+  - ``container_rows_filtered_sip``
+  - ``container_rows_pruned_sip``
 
   and more...
 
 - There is a new tab which helps you select particular tooltips from any select path id.
-- A new tab also highlights if there are any non-default ``SESSION PARAMETERS``.
+- A new tab also highlights if there are any non-default ``SESSION PARAMETERS`` .
 - Improved the efficiency of plotting the tree by chaching results.
 
 QueryProfilerComparison
 ++++++++++++++++++++++++
 
-- :py:class:`~verticapy.performance.vertica.qprof.QueryProfilerComparison` class offers an extended set of functionalities, enabling the creation of complex trees with multiple metrics.
+- :py:class:`~verticapy.performance.vertica.qprof_interface.QueryProfilerComparison` class offers an extended set of functionalities, enabling the creation of complex trees with multiple metrics.
 
 .. code-block:: python
     
   from verticapy.performance.vertica import QueryProfilerInterface
 
   qprof_interface_1 = QueryProfilerInterface(
-      key_id='key_1',
-      target_schema='schema_1',
-      )
+    key_id = "key_1",
+    target_schema = "schema_1",
+  )
 
   qprof_interface_2 = QueryProfilerInterface(
-      key_id='key_2',
-      target_schema='schema_1',
-      )
+    key_id = "key_2",
+    target_schema = "schema_1",
+  )
 
   from verticapy.performance.vertica import QueryProfilerComparison
 
-  qprof_compare = QueryProfilerComparison(qprof_interface_1,qprof_interface_2)
+  qprof_compare = QueryProfilerComparison(qprof_interface_1, qprof_interface_2)
 
   qprof_compare.get_qplan_tree()
 
@@ -132,6 +127,4 @@ Deprecations
 
   Because of the re-structuring of VerticaPy, some previous imports will not work.
 
-Please look at the latest doc for the up-to-date imports.
-
-
+Please look at the latest doc for the up-to-date imports.

setup.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2023 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/__init__.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_config/__init__.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_config/config.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_config/validators.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_help.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_typing.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_utils/__init__.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.

verticapy/_utils/_display.py

@@ -1,5 +1,5 @@
 """
-Copyright  (c)  2018-2024 Open Text  or  one  of its
+Copyright  (c)  2018-2025 Open Text  or  one  of its
 affiliates.  Licensed  under  the   Apache  License,
 Version 2.0 (the  "License"); You  may  not use this
 file except in compliance with the License.