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

docs: show table of import times and package sizes in README #15805

Closed
wants to merge 1 commit into from

Conversation

MarcoGorelli
Copy link
Collaborator

@MarcoGorelli MarcoGorelli commented Apr 20, 2024

see https://github.com/pola-rs/polars/tree/table-for-comparisons?tab=readme-ov-file#lightweight for how it looks

EDIT: will move the asset location to polars-static

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Apr 20, 2024
@MarcoGorelli MarcoGorelli marked this pull request as ready for review April 20, 2024 17:26
@MarcoGorelli MarcoGorelli marked this pull request as draft April 20, 2024 18:02
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Looks great! Just wondering two things:

  • Are the sizes/import timings up-to-date?
  • Perhaps we should use polars-static repo to upload the image (just like we use for the logo): https://github.com/pola-rs/polars-static
  • Maybe this would look nicer as a dark mode plot? It looks like below to me which is not very easy on the eyes:

image

@@ -157,11 +157,9 @@ Polars is very fast. In fact, it is one of the best performing solutions availab

### Lightweight

Polars is also very lightweight. It comes with zero required dependencies, and this shows in the import times:
Polars is also very lightweight, as shown by its relatively small package size and low import times.
Copy link
Member

Choose a reason for hiding this comment

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

May also be worth mentioning here that Polars comes with zero required dependencies!

@ritchie46
Copy link
Member

Maybe this would look nicer as a dark mode plot? It looks like below to me which is not very easy on the eyes:

Do you have dark-mode in the browser? I mean, it looks fine in light-mode? 😅

Perhaps we should use polars-static repo to upload the image (just like we use for the logo): https://github.com/pola-rs/polars-static

Yes, plots/images should be in polars-static.

@stinodego
Copy link
Member

We can create a light mode and a dark mode plot and show the correct one depending on the user's theme. From the astral/uv README:

<p align="center">
  <picture align="center">
    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/astral-sh/uv/assets/1309177/03aa9163-1c79-4a87-a31d-7a9311ed9310">
    <source media="(prefers-color-scheme: light)" srcset="https://github.com/astral-sh/uv/assets/1309177/629e59c0-9c6e-4013-9ad4-adb2bcf5080d">
    <img alt="Shows a bar chart with benchmark results." src="https://github.com/astral-sh/uv/assets/1309177/629e59c0-9c6e-4013-9ad4-adb2bcf5080d">
  </picture>
</p>

@MarcoGorelli
Copy link
Collaborator Author

Yes, plots/images should be in polars-static.

cool, will pick this up again later / there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants