Docs/add api reference#89
Closed
davidberenstein1957 wants to merge 11 commits into
Closed
Conversation
- Removed outdated telemetry instructions from README.md and added a new dedicated telemetry documentation file. - Updated contributions table of contents to include the new telemetry documentation. - Revised evaluation and dataset user manuals for clarity and consistency. - Improved formatting and organization of code examples across various documentation files.
…bution guidelines - Introduced a new issue template for documentation improvements to streamline suggestions from the community. - Updated the "How to Contribute" section to include a reference to the new documentation improvement template. - Enhanced the "Opening an Issue" section with detailed instructions on submitting documentation changes.
- Standardized formatting in the README.md, including consistent line endings and spacing. - Enhanced the section on getting started with Pruna, ensuring clarity in code examples. - Updated the algorithm overview table to provide a clearer presentation of compression techniques and their benefits. - Added detailed descriptions for specific models, including Stable Diffusion XL, FLUX [dev], and HunyuanVideo, with links to relevant resources.
- Eliminated outdated telemetry setup instructions from the README.md to streamline the quick start section. - Focused on enhancing the clarity of the getting started experience with Pruna.
- Expanded the explanation of Pruna's `smash` function to include information about various compression and optimization algorithms. - Removed redundant code example to streamline the documentation and improve clarity. - Updated the `SmashConfig` section to include the `compiler` option for better user guidance.
- Replaced the static contributor image link with a dynamic one from contrib.rocks to enhance visibility and ensure it reflects the latest contributors. - This change aims to foster community engagement by showcasing contributors in a more engaging manner.
- Changed the citation block in the README.md to use a consistent BibTeX format. - Ensured proper spacing and syntax for improved readability and adherence to citation standards.
- Deleted the ASR Whisper tutorial notebook to streamline documentation. - Introduced a new index file for tutorials, providing an overview and links to various optimization guides for different models, enhancing user navigation and accessibility.
- Deleted the contributions table of contents file to streamline documentation structure. - Updated tutorial links in the index file to point to the correct notebook paths, enhancing navigation for users.
- Added comprehensive guides for customizing algorithms, datasets, and metrics, providing users with clear steps to integrate their own components into |pruna|. - Introduced detailed documentation on evaluating model optimizations using the Evaluation Agent, outlining the workflow and available metrics. - Updated the configuration guide to include new features and examples for defining a SmashConfig, improving user experience and clarity. - Enhanced the optimization guide with step-by-step instructions for optimizing various model types, including diffusion models and large language models. - Improved the save and load documentation for PrunaModels, ensuring users understand the new functionalities and best practices for model management.
…iguration - Deleted the old user manuals for datasets, evaluation, SmashConfig, and the smash function to streamline documentation and remove redundancy. - This cleanup aims to enhance the clarity and accessibility of the documentation for users, focusing on more current and relevant content.
Member
Author
|
Close over #90 |
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
1 participant
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
Related Issue
Fixes #(issue number)
Type of Change
How Has This Been Tested?
Checklist
Additional Notes