Skip to content

docs: correct the params rendering for ml.remote and ml.ensemble modules #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 5, 2023

Conversation

ashleyxuu
Copy link
Contributor

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Fixes internal issue 314150462 🦕

@ashleyxuu ashleyxuu requested review from a team as code owners November 30, 2023 18:40
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Nov 30, 2023
@ashleyxuu ashleyxuu changed the title docs: fix the params rendering for ml.remote and ml.ensemble docs: fix the params rendering for ml.remote and ml.ensemble modules Nov 30, 2023
@ashleyxuu ashleyxuu changed the title docs: fix the params rendering for ml.remote and ml.ensemble modules docs: correct the params rendering for ml.remote and ml.ensemble modules Nov 30, 2023
@GarrettWu GarrettWu added the automerge Merge the pull request once unit tests and other checks pass. label Dec 4, 2023
@gcf-merge-on-green gcf-merge-on-green bot merged commit c2829e3 into main Dec 5, 2023
@gcf-merge-on-green gcf-merge-on-green bot deleted the ashleyxu-fix-params-rendering branch December 5, 2023 00:18
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Dec 5, 2023
Genesis929 pushed a commit that referenced this pull request Dec 11, 2023
…modules (#248)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
  - `ensemble.RandomForestClassifier`: https://screenshot.googleplex.com/4Q88xgdm5hkaYXu
  - `ensemble.RandomForestRegressor`: https://screenshot.googleplex.com/3CU6pJBjYHQvnDo
  - `remote.VertexAIModel`: https://screenshot.googleplex.com/8SL2max6GfPMwFe

Fixes internal issue 314150462 🦕
Genesis929 added a commit that referenced this pull request Dec 11, 2023
#252)

* docs: add example for dataframe.melt, dataframe.pivot, dataframe.stack, dataframe.unstack

* remove empty line

* docstring fix

* spacing update

* docs: correct the params rendering for `ml.remote` and `ml.ensemble` modules (#248)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
  - `ensemble.RandomForestClassifier`: https://screenshot.googleplex.com/4Q88xgdm5hkaYXu
  - `ensemble.RandomForestRegressor`: https://screenshot.googleplex.com/3CU6pJBjYHQvnDo
  - `remote.VertexAIModel`: https://screenshot.googleplex.com/8SL2max6GfPMwFe

Fixes internal issue 314150462 🦕

* docs: add examples for dataframe.nunique, dataframe.diff, dataframe.a… (#251)

* docs: add examples for dataframe.nunique, dataframe.diff, dataframe.agg, dataframe.describe

* update spacing

* update ordering

* docs: Fix return annotation in API docstrings (#253)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes internal issue 314367409 🦕

* feat: add nunique method to Series/DataFrameGroupby (#256)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

* docs: add example for dataframe.melt, dataframe.pivot, dataframe.stack, dataframe.unstack

* docstring fix

---------

Co-authored-by: Ashley Xu <[email protected]>
Co-authored-by: Shobhit Singh <[email protected]>
Co-authored-by: TrevorBergeron <[email protected]>
Genesis929 pushed a commit that referenced this pull request Dec 12, 2023
…modules (#248)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
  - `ensemble.RandomForestClassifier`: https://screenshot.googleplex.com/4Q88xgdm5hkaYXu
  - `ensemble.RandomForestRegressor`: https://screenshot.googleplex.com/3CU6pJBjYHQvnDo
  - `remote.VertexAIModel`: https://screenshot.googleplex.com/8SL2max6GfPMwFe

Fixes internal issue 314150462 🦕
Genesis929 added a commit that referenced this pull request Dec 12, 2023
#252)

* docs: add example for dataframe.melt, dataframe.pivot, dataframe.stack, dataframe.unstack

* remove empty line

* docstring fix

* spacing update

* docs: correct the params rendering for `ml.remote` and `ml.ensemble` modules (#248)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
  - `ensemble.RandomForestClassifier`: https://screenshot.googleplex.com/4Q88xgdm5hkaYXu
  - `ensemble.RandomForestRegressor`: https://screenshot.googleplex.com/3CU6pJBjYHQvnDo
  - `remote.VertexAIModel`: https://screenshot.googleplex.com/8SL2max6GfPMwFe

Fixes internal issue 314150462 🦕

* docs: add examples for dataframe.nunique, dataframe.diff, dataframe.a… (#251)

* docs: add examples for dataframe.nunique, dataframe.diff, dataframe.agg, dataframe.describe

* update spacing

* update ordering

* docs: Fix return annotation in API docstrings (#253)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes internal issue 314367409 🦕

* feat: add nunique method to Series/DataFrameGroupby (#256)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

* docs: add example for dataframe.melt, dataframe.pivot, dataframe.stack, dataframe.unstack

* docstring fix

---------

Co-authored-by: Ashley Xu <[email protected]>
Co-authored-by: Shobhit Singh <[email protected]>
Co-authored-by: TrevorBergeron <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants