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-#6987: Rework range-partitioning docs #7169

Merged
merged 5 commits into from
Apr 15, 2024

Conversation

dchigarev
Copy link
Collaborator

@dchigarev dchigarev commented Apr 10, 2024

What do these changes do?

This PR:

  1. Moves range-partitioning documentation section from flow/experimental/... to usage_guide/optimization_notes
  2. The introduction of what range-partitioning is, was placed on the optimization notes page
  3. The description of each range-partitioning operation was separated and placed on a separate page (optimization notes hold a link to that page)
  4. Described all the methods that support range-partitioning
  5. Added performance measurements for some of the operations (perf measurements and micro-benchmark scripts were copied from the respective PRs without any changes)

Links to the rendered pages:

The check-list:

  • first commit message and PR title follow format outlined here

    NOTE: If you edit the PR title to match this format, you need to add another commit (even if it's empty) or amend your last commit for the CI job that checks the PR title to pick up the new PR title.

  • passes flake8 modin/ asv_bench/benchmarks scripts/doc_checker.py
  • passes black --check modin/ asv_bench/benchmarks scripts/doc_checker.py
  • signed commit with git commit -s
  • Resolves Rework documentation regarding range-partitioning implementations #6987
  • tests added and passing
  • module layout described at docs/development/architecture.rst is up-to-date

Signed-off-by: Dmitry Chigarev <dmitry.chigarev@intel.com>
Signed-off-by: Dmitry Chigarev <dmitry.chigarev@intel.com>
Signed-off-by: Dmitry Chigarev <dmitry.chigarev@intel.com>
@dchigarev dchigarev marked this pull request as ready for review April 15, 2024 11:19
@dchigarev dchigarev changed the title DOCS-#6987: Rework range-partitioning docs (WIP) DOCS-#6987: Rework range-partitioning docs Apr 15, 2024
@@ -1,107 +1,8 @@
Range-partitioning GroupBy
""""""""""""""""""""""""""
:orphan:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should remove this page at all as we do not reference it anywhere?

Copy link
Collaborator Author

@dchigarev dchigarev Apr 15, 2024

Choose a reason for hiding this comment

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

we still may have a reference to this page somewhere outside our docs (messages, gh issues/comments, blog posts, in-code comments). So I would prefer an automatic redirect to a new page instead of 404

@@ -4,5 +4,5 @@
.. raw:: html
Copy link
Collaborator

Choose a reason for hiding this comment

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

same

docs/usage_guide/optimization_notes/index.rst Outdated Show resolved Hide resolved
docs/usage_guide/optimization_notes/index.rst Outdated Show resolved Hide resolved
Signed-off-by: Dmitry Chigarev <dmitry.chigarev@intel.com>
@YarShev YarShev merged commit fb14a75 into modin-project:master Apr 15, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rework documentation regarding range-partitioning implementations
2 participants