Skip to content
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

SNOW-1320543 Update modin class paths #1469

Merged
merged 2 commits into from
May 1, 2024

Conversation

sfc-gh-vbudati
Copy link
Contributor

Please answer these questions before submitting your pull requests. Thanks!

  1. What GitHub issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Fixes SNOW-1320543

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
    • I am adding new logging messages
    • I am adding a new telemetry message
    • I am adding new credentials
    • I am adding a new dependency
  3. Please describe how your code solves the related issue.

    Change modin classpaths from snowflake.snowpark.modin.pandas.<> to modin.pandas.<>.

To see the changes locally run:

cd docs
make clean; make html
open -a "Google Chrome" build/html/index.html

To see the docs in a nice format, change the variable html_theme in docs/source/conf.py:70 to "alabaster".

@sfc-gh-vbudati sfc-gh-vbudati requested a review from a team as a code owner April 30, 2024 22:51
@sfc-gh-vbudati sfc-gh-vbudati added NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md NO-PANDAS-CHANGELOG-UPDATES labels Apr 30, 2024
Copy link
Contributor

@sfc-gh-nkrishna sfc-gh-nkrishna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! What's the downside of permanently leaving it as "alabaster" it's so much nicer lol

@sfc-gh-vbudati
Copy link
Contributor Author

@sfc-gh-nkrishna I have no idea lol. There was a comment in the ol' snowpandas fork that mentioned "switching back to the empty theme once merged back". Just following orders, although it is a very nice theme. 😆

Copy link
Contributor

@sfc-gh-joshi sfc-gh-joshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for figuring this out!

Copy link
Contributor

@sfc-gh-aling sfc-gh-aling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not familiar with doc generation, but you should be able to verify your change through the doc in the generated artifacts: https://github.com/snowflakedb/snowpark-python/actions/runs/8902614293?pr=1469#artifacts

@sfc-gh-vbudati
Copy link
Contributor Author

@sfc-gh-joshi @sfc-gh-nkrishna I was double checking the docs generated by this code:
on the pages for general functions (anything in snowflake.snowpark.modin.pandas.general/general_functions.rst) the class path displayed below the function name is still snowflake.snowpark.modin.pandas.melt instead of modin.pandas.melt. This is also the case for the class pages of Series and DataFrame where the full classpath is displayed.

I'm not sure how to fix this, not sure if this is worth fixing. All the other APIs are displayed correctly. The headings are displayed correctly - this is just the module line that has the "full" classpath present in the aforementioned files.

What do you think?

Take a look at the docs for:

  • snowflake.snowpark.modin.pandas.Series.html
  • snowflake.snowpark.modin.pandas.general.melt.html
  • snowflake.snowpark.modin.pandas.DataFrame.html
    versus the expected (any other file that's not in general).

@sfc-gh-nkrishna
Copy link
Contributor

sfc-gh-nkrishna commented May 1, 2024

@sfc-gh-joshi @sfc-gh-nkrishna I was double checking the docs generated by this code: on the pages for general functions (anything in snowflake.snowpark.modin.pandas.general/general_functions.rst) the class path displayed below the function name is still snowflake.snowpark.modin.pandas.melt instead of modin.pandas.melt. This is also the case for the class pages of Series and DataFrame where the full classpath is displayed.

I'm not sure how to fix this, not sure if this is worth fixing. All the other APIs are displayed correctly. The headings are displayed correctly - this is just the module line that has the "full" classpath present in the aforementioned files.

What do you think?

Take a look at the docs for:

  • snowflake.snowpark.modin.pandas.Series.html
  • snowflake.snowpark.modin.pandas.general.melt.html
  • snowflake.snowpark.modin.pandas.DataFrame.html
    versus the expected (any other file that's not in general).

@sfc-gh-vbudati This is behavior we should run by Sri/Brenan I think. Maybe worth a post on the channel? IMO this isn't a big deal since the repo is public anyways so any user can see the file path/structure if they wanted to.

@sfc-gh-vbudati sfc-gh-vbudati merged commit 4828219 into main May 1, 2024
27 of 28 checks passed
@sfc-gh-vbudati sfc-gh-vbudati deleted the vbudati/SNOW-1320543-update-modin-class-paths branch May 1, 2024 19:11
@github-actions github-actions bot locked and limited conversation to collaborators May 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants