Merge branch 'main' into derekk/nvfp4-example-tests

Author: dbarbuzzi

.gitignore

@@ -93,9 +93,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-
 # PyBuilder
 target/
 
@@ -129,6 +126,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+docs/.cache/
 
 # mypy
 .mypy_cache/

README.md

@@ -38,7 +38,7 @@ Some of the exciting new features include:
 
 ### When to Use Which Optimization
 
-Please refer to [docs/schemes.md](./docs/schemes.md) for detailed information about available optimization schemes and their use cases.
+Please refer to [compression_schemes.md](./docs/guides/compression_schemes.md) for detailed information about available optimization schemes and their use cases.
 
 
 ## Installation

docs/Makefile

@@ -0,0 +1,26 @@
+# Minimal mkdocs makefile
+
+PYTHON      := python3
+MKDOCS_CMD  := mkdocs
+MKDOCS_CONF := ../mkdocs.yml
+
+.PHONY: help install serve build clean
+
+help:
+	@echo "Available targets:"
+	@echo "  install  Install dependencies globally"
+	@echo "  serve    Serve docs locally"
+	@echo "  build    Build static site"
+	@echo "  clean    Remove build artifacts"
+
+install:
+	pip install -e "../[dev]"
+
+serve:
+	$(MKDOCS_CMD) serve --livereload -f $(MKDOCS_CONF)
+
+build:
+	$(MKDOCS_CMD) build -f $(MKDOCS_CONF)
+
+clean:
+	rm -rf site/ .cache/ 

docs/README.md

@@ -0,0 +1,25 @@
+# Getting started with LLM Compressor docs
+
+```bash
+cd docs
+```
+
+- Install the dependencies:
+
+```bash
+make install
+```
+
+- Clean the previous build (optional but recommended):
+
+```bash
+make clean
+```
+
+- Serve the docs:
+
+```bash
+make serve
+```
+
+This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.

docs/developer/code-of-conduct.md

@@ -0,0 +1,82 @@
+---
+title: Code of Conduct
+weight: -10
+---
+
+# LLM Compressor Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement through GitHub, Slack, or Email. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

docs/developer/contributing.md

@@ -0,0 +1,58 @@
+---
+title: Contributing Guide
+weight: -8
+---
+
+# Contributing to LLM Compressor
+
+Thank you for your interest in contributing to LLM Compressor!
+Our community is open to everyone and welcomes all kinds of contributions, no matter how small or large.
+There are several ways you can contribute to the project:
+
+- Identify and report any issues or bugs.
+- Request or add new compression methods or research.
+- Suggest or implement new features.
+
+However, remember that contributions aren't just about code.
+We believe in the power of community support; thus, answering queries, assisting others, and enhancing the documentation are highly regarded and beneficial contributions.
+
+Finally, one of the most impactful ways to support us is by raising awareness about LLM Compressor and the vLLM community.
+Talk about it in your blog posts, highlighting how it's driving your incredible projects.
+Express your support on Twitter if vLLM aids you, or simply offer your appreciation by starring our repository.
+
+## Setup for development
+
+### Install from source
+
+```bash
+pip install -e ./[dev]
+```
+
+### Code Styling and Formatting checks
+
+```bash
+make style
+make quality
+```
+
+### Testing
+
+```bash
+make test
+```
+
+## Contributing Guidelines
+
+### Issue Reporting
+
+If you encounter a bug or have a feature request, please check our issues page first to see if someone else has already reported it.
+If not, please file a new issue, providing as much relevant information as possible.
+
+### Pull Requests & Code Reviews
+
+Please check the PR checklist in the [PR template](.github/PULL_REQUEST_TEMPLATE.md) for detailed guide for contribution.
+
+### Thank You
+
+Finally, thank you for taking the time to read these guidelines and for your interest in contributing to LLM Compressor.
+Your contributions make LLM Compressor a great tool for everyone!

docs/developer/developing.md

@@ -0,0 +1,139 @@
+---
+title: Development Guide
+weight: -6
+---
+
+# Developing LLM Compressor
+
+LLM Compressor is developed and tested using Python 3.8-3.11.
+To develop LLM Compressor, you will also need the development dependencies and to follow the styling guidelines.
+
+Here are some details to get started.
+
+## Basic Commands
+
+**Development Installation**
+
+```bash
+git clone https://github.com/vllm-project/llm-compressor
+cd llm-compressor
+python3 -m pip install -e "./[dev]"
+```
+
+This will clone the LLM Compressor repo, install it, and install the development dependencies.
+
+**Code Styling and Formatting checks**
+
+```bash
+make style
+make quality
+```
+
+This will run automatic code styling using `ruff`, `flake8`, `black`, and `isort` to test that the
+repository's code matches its standards.
+
+**EXAMPLE: test changes locally**
+
+```bash
+make test
+```
+
+This will run the targeted LLM Compressor unit tests for the frameworks specified.
+
+File any error found before changes as an Issue and fix any errors found after making changes before submitting a Pull Request.
+
+## GitHub Workflow
+
+1. Fork the `llm-compressor` repository into your GitHub account: https://github.com/vllm-project/llm-compressor.
+
+2. Clone your fork of the GitHub repository, replacing `<username>` with your GitHub username.
+
+   Use ssh (recommended):
+
+   ```bash
+   git clone [email protected]:<username>/llm-compressor.git
+   ```
+
+   Or https:
+
+   ```bash
+   git clone https://github.com/<username>/llm-compressor.git
+   ```
+
+3. Add a remote to keep up with upstream changes.
+
+   ```bash
+   git remote add upstream https://github.com/vllm-project/llm-compressor.git
+   ```
+
+   If you already have a copy, fetch upstream changes.
+
+   ```bash
+   git fetch upstream
+   ```
+
+4. Create a feature branch to work in.
+
+   ```bash
+   git checkout -b feature-xxx upstream/main
+   ```
+
+5. Work in your feature branch.
+
+   ```bash
+   git commit -a
+   ```
+
+6. Periodically rebase your changes
+
+   ```bash
+   git pull --rebase
+   ```
+
+7. When done, combine ("squash") related commits into a single one
+
+   ```bash
+   git rebase -i upstream/main
+   ```
+
+   This will open your editor and allow you to re-order commits and merge them:
+   - Re-order the lines to change commit order (to the extent possible without creating conflicts)
+   - Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits.
+
+8. Submit a pull-request
+
+   ```bash
+   git push origin feature-xxx
+   ```
+
+   Go to your fork main page
+
+   ```bash
+   https://github.com/<username>/llm-compressor
+   ```
+
+   If you recently pushed your changes GitHub will automatically pop up a `Compare & pull request` button for any branches you recently pushed to. If you click that button it will automatically offer you to submit your pull-request to the `vllm-project/llm-compressor` repository.
+
+   - Give your pull-request a meaningful title.
+     You'll know your title is properly formatted once the `Semantic Pull Request` GitHub check
+     transitions from a status of "pending" to "passed".
+   - In the description, explain your changes and the problem they are solving.
+
+9. Addressing code review comments
+
+   Repeat steps 5. through 7. to address any code review comments and rebase your changes if necessary.
+
+   Push your updated changes to update the pull request
+
+   ```bash
+   git push origin [--force] feature-xxx
+   ```
+
+   `--force` may be necessary to overwrite your existing pull request in case your
+  commit history was changed when performing the rebase.
+
+   Note: Be careful when using `--force` since you may lose data if you are not careful.
+
+   ```bash
+   git push origin --force feature-xxx
+   ```

docs/examples/index.md

@@ -2,8 +2,8 @@
 weight: -4
 ---
 
-# Examples
+# LLM Compressor examples
 
-Welcome to the LLM Compressor examples section! Here, you'll find practical demonstrations showing how to use LLM Compressor to optimize large language models for faster and more efficient deployment with vLLM. These examples will help you understand the various compression techniques and functionalities available in LLM Compressor, making it easier to apply them to your own models.
+This section provides practical demonstrations showing how to use LLM Compressor to optimize large language models for faster and more efficient deployment with vLLM. These examples will help you understand the various compression techniques and functionalities available in LLM Compressor, making it easier to apply them to your own models.
 
-To explore the examples, you can either navigate through the list provided in the sidebar or click next to see the next example in the series. Each example is designed to be self-contained, with clear instructions and code snippets that you can run directly.
+Each example is designed to be self-contained, with clear instructions and code snippets that you can run directly.