Sphinx Docstring Update for MachineLearning/Vertica/LinearModel #753
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Draft for LinearRegression. Rest of the ml algortihm classes will follow the same syntax.
Fixing the example. @mail4umar: TODO - Verify each reference, for some them the link needs to be added. Please double check the code.
oualib
requested changes
Oct 21, 2023
| The following examples provide a basic understanding of usage. For more | ||
| detailed examples, please refer to the User Guide or the "Examples" | ||
| The following examples provide a basic understanding of usage. For more | ||
| detailed examples, please refer to the :ref:`user_guide.machine_learning` or the "Examples" |
There was a problem hiding this comment.
add link to the example page of the VerticaPy Website.
| By assigning an alias to ``verticapy``, we mitigate the risk of code | ||
| collisions with other libraries. This precaution is necessary | ||
| because verticapy uses commonly known function names like "average" | ||
| and "median," which can potentially lead to naming conflicts. |
| The following examples provide a basic understanding of usage. For more | ||
| detailed examples, please refer to the User Guide or the "Examples" | ||
| The following examples provide a basic understanding of usage. For more | ||
| detailed examples, please refer to the :ref:`user_guide.machine_learning` or the "Examples" |
There was a problem hiding this comment.
Also PEP, try to go back to the next line after the ref.
| use them effectively. These datasets are invaluable resources for honing your | ||
| VerticaPy offers a wide range of sample datasets that are ideal for training | ||
| and testing purposes. You can explore the full list of available datasets in | ||
| the :ref:`api.datasets`, which provides detailed information on each dataset and how to |
There was a problem hiding this comment.
PEP go back to line after dataset.
| In this case, VerticaPy utilizes seeded randomization to guarantee the | ||
| reproducibility of your data split. However, please be aware that this | ||
| approach may lead to reduced performance. For a more efficient data | ||
| split, you can use the :py:mod:`vDataFrame.to_db` method to save your results |
| @@ -650,19 +650,19 @@ class LinearRegression(Regressor, LinearModel): | |||
|
|
|||
| vp.set_option("plotting_lib", "plotly") | |||
| fig = model.features_importance() | |||
| fig.write_html("SPHINX_DIRECTORY/figures/machine_learning_vertica_linear_model_lr_feature.html") | |||
oualib
approved these changes
Oct 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Draft for LinearRegression. Rest of the ml algorithm classes will follow the same syntax.
@oualib can you please check.