docs: general structure refactor#90
Merged
Merged
Conversation
… with algorithm overview
…metrics, and model optimization
…d community engagement options
…gorithms, metrics, and datasets
… and saving/loading processes
… configuration, evaluation, and saving/loading
Closed
10 tasks
davidberenstein1957
requested review from
begumcig,
johnrachwan123 and
nifleisch
and removed request for
begumcig
Member
Author
|
available here: https://docs.pruna.ai/en/docs-general-structure-refactor/ |
begumcig
requested changes
May 6, 2025
begumcig
left a comment
begumcig
left a comment
Member
There was a problem hiding this comment.
This looks fantastic! I really love the new structure for the API and user manuals, it’s so much clearer now. The graphs were especially super helpful for understanding how the modules fit together. I’ve just added a few small comments in the Evaluation section. Great work overall!!!
davidberenstein1957
force-pushed
the
docs/general-structure-refactor
branch
from
de885cf to
049278c
Compare
johannaSommer
previously requested changes
May 6, 2025
johannaSommer
left a comment
johannaSommer
left a comment
Member
There was a problem hiding this comment.
I am in love with this documentation update, thanks a lot for all your hard work! Just left a few comments to consider in one more iteration, but its almost flawless already 🌻
- Updated test cases in `test_code_blocks.py` to dynamically generate parameters for user manuals and contributions, excluding the 'dataset' tutorial. - Improved maintainability by leveraging glob patterns to include all relevant `.rst` files.
sharpenb
reviewed
May 6, 2025
sharpenb
reviewed
May 6, 2025
sharpenb
reviewed
May 6, 2025
sharpenb
reviewed
May 6, 2025
sharpenb
reviewed
May 6, 2025
… configuration, evaluation, and saving/loading
- Updated test cases in `test_code_blocks.py` to dynamically generate parameters for user manuals and contributions, excluding the 'dataset' tutorial. - Improved maintainability by leveraging glob patterns to include all relevant `.rst` files.
…, datasets, metrics, and model optimization - Added detailed guides for adding custom algorithms, datasets, and metrics to the user manual. - Introduced a comprehensive tutorial on optimizing models with Pruna, including step-by-step workflows and example use cases. - Updated existing documentation for clarity and consistency across sections.
…nsistency - Replaced empty entries with a standardized symbol (➖) to indicate algorithms that have an approximate same impact. - Adjusted the legend to reflect the updated symbols for improved understanding.
- Changed references from "compression algorithms" to "optimization algorithms" for consistency. - Updated installation link for pip to direct users to the correct page. - Removed redundant line breaks and improved formatting for better readability. - Enhanced the algorithm overview table with clearer descriptions and standardized symbols.
…PrunaAI/pruna into docs/general-structure-refactor
begumcig
requested changes
May 8, 2025
begumcig
left a comment
begumcig
left a comment
Member
There was a problem hiding this comment.
Almost there! Left small notes
- Changed the reference from "PrunaModel" to "EvaluationAgent" to accurately reflect the evaluation process. - Ensured consistency in terminology within the evaluation workflow section.
- Changed "Stateless Metrics" to "Stateful Metrics" for accurate representation of metrics that maintain internal state across batches.
sharpenb
reviewed
May 9, 2025
sharpenb
reviewed
May 9, 2025
sharpenb
reviewed
May 9, 2025
sharpenb
approved these changes
May 9, 2025
sharpenb
left a comment
sharpenb
left a comment
Member
There was a problem hiding this comment.
Thanks a lot for all the udpates! I left some small comments. I can be merged after they are fixed ( and the sister PR is merged) :)
…nd evaluation modes - Renamed section "Adding a Metric" to "Customize a Metric" for improved clarity. - Added details on pairwise evaluation mode options to the evaluation metrics section.
begumcig
requested changes
May 12, 2025
…c terminology - Updated the evaluation workflow diagram to clarify the relationships between components. - Changed terminology from "uses" to "is used by" for better accuracy. - Standardized metric type references and improved subgraph labeling for consistency.
- Added new styles for components B and C in the evaluation workflow diagram for better visual distinction. - Improved overall clarity of the diagram to aid user understanding of the evaluation process.
begumcig
approved these changes
May 13, 2025
begumcig
left a comment
begumcig
left a comment
Member
There was a problem hiding this comment.
Thank you so much for the fantastic work, genuinely excited about the new docs! 🥇🥇🥇
davidberenstein1957
dismissed
johannaSommer’s stale review
changed everything already
davidberenstein1957
requested review from
johnrachwan123
and removed request for
johannaSommer and
johnrachwan123
Member
Author
|
@begumcig would you be able to re-do this from your account too? |
Member
Author
Merging without given that the failing tests passes locally to be included in the next release and there is some mixup within the CICD.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Available https://docs.pruna.ai/en/docs-general-structure-refactor/
Related Issue
Fixes #55
Type of Change
How Has This Been Tested?
Checklist
Additional Notes