Initial_audit_changes #1436
Open
Initial_audit_changes #1436
+58
−48
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
Create some initial changes to the docs based on my audit suggestions.
levkk
reviewed
May 2, 2024
levkk
reviewed
May 2, 2024
levkk
reviewed
May 2, 2024
| @@ -63,7 +63,7 @@ This will create a "My Classification Project", copy the `pgml.digits` table int | |||
|
|
|||
| When used for the first time in a project, `pgml.train()` function requires the `task` parameter, which can be either `regression` or `classification`. The task determines the relevant metrics and analysis performed on the data. All models trained within the project will refer to those metrics and analysis for benchmarking and deployment. | |||
|
|
|||
| The first time it's called, the function will also require a `relation_name` and `y_column_name`. The two arguments will be used to create the first snapshot of training and test data. By default, 25% of the data (specified by the `test_size` parameter) will be randomly sampled to measure the performance of the model after the `algorithm` has been trained on the 75% of the data. | |||
| The first time it is called, the function will also require a `relation_name` and `y_column_name`. The two arguments will be used to create the first snapshot of training and test data. By default, 25% of the data (specified by the `test_size` parameter) will be randomly sampled to measure the performance of the model after the `algorithm` has been trained on the 75% of the data. | |||
There was a problem hiding this comment.
Why do we prefer not using contractions?
There was a problem hiding this comment.
I suggested it as a way to make it simpler for non-native English speakers to read.
Another reason is for translation, but I figured you probably have no plans for that at this point.
Fix a missing ending para and remove blank targets.
montanalow
reviewed
May 3, 2024
| @@ -37,7 +37,7 @@ pgml.train( | |||
| | `task` | `'regression'` | The objective of the experiment: `regression`, `classification` or `cluster` | | |||
| | `relation_name` | `'public.search_logs'` | The Postgres table or view where the training data is stored or defined. | | |||
| | `y_column_name` | `'clicked'` | The name of the label (aka "target" or "unknown") column in the training table. | | |||
| | `algorithm` | `'xgboost'` | <p>The algorithm to train on the dataset. | | |||
| | `algorithm` | `'xgboost'` | <p>The algorithm to train on the dataset.</p> | | |||
There was a problem hiding this comment.
We don't need the <p> if we're not nesting multiple links, but why remove the links?
Suggested change
| | `algorithm` | `'xgboost'` | <p>The algorithm to train on the dataset.</p> | | |
| | `algorithm` | `'xgboost'` | The algorithm to train on the dataset. | |
There was a problem hiding this comment.
The links 404'ed. Do the pages still exist?
There was a problem hiding this comment.
Yeah, these are supposed to link to
pgml-cms/docs/api/sql-extension/pgml.transform/text-generation.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Montana Low <[email protected]>
Update based on Montana feedback
Modify HuggingFace to Hugging Face in multiple pages.
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.
Create some initial changes to the docs based on my audit suggestions.