@tduncan / Nvidia-Optimization-Stack-VLLM Mirror · read-only / commits / 3a7f15a398
Fork 0

A high-throughput and memory-efficient inference and serving engine for LLMs

Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git

Synced Nov 16, 08:15 UTC

[Doc] Move CONTRIBUTING to docs site (#9924)

Signed-off-by: Russell Bryant <rbryant@redhat.com>

Russell Bryant committed Nov 8, 2024 at 00:15 UTC 3a7f15a398727887137a021b8b32dc372b532087
10 files changed +100 -68
CONTRIBUTING.md
+1 -58
@@ -1,60 +1,3 @@
1 # Contributing to vLLM
2
3 -Thank you for your interest in contributing to vLLM! 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:
4 -
5 -- Identify and report any issues or bugs.
6 -- Request or add support for a new model.
7 -- Suggest or implement new features.
8 -- Improve documentation or contribute a how-to guide.
9 -
10 -We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also highly regarded and beneficial contributions.
11 -
12 -Finally, one of the most impactful ways to support us is by raising awareness about vLLM. Talk about it in your blog posts and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository!
13 -
14 -## License
15 -
16 -See [LICENSE](LICENSE).
17 -
18 -## Developing
19 -
20 -Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the [building from source](https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source) documentation for details.
21 -
22 -## Testing
23 -
24 -```bash
25 -pip install -r requirements-dev.txt
26 -
27 -# linting and formatting
28 -bash format.sh
29 -# Static type checking
30 -mypy
31 -# Unit tests
32 -pytest tests/
33 -```
34 -**Note:** Currently, the repository does not pass the ``mypy`` tests.
35 -
36 -## Contribution Guidelines
37 -
38 -### DCO and Signed-off-by
39 -
40 -When contributing changes to this project, you must agree to the [DCO](DCO).
41 -Commits must include a `Signed-off-by:` header which certifies agreement with
42 -the terms of the [DCO](DCO).
43 -
44 -Using `-s` with `git commit` will automatically add this header.
45 -
46 -### Issues
47 -
48 -If you encounter a bug or have a feature request, please [search existing issues](https://github.com/vllm-project/vllm/issues?q=is%3Aissue) first to see if it has already been reported. If not, please [file a new issue](https://github.com/vllm-project/vllm/issues/new/choose), providing as much relevant information as possible.
49 -
50 -> [!IMPORTANT]
51 -> If you discover a security vulnerability, please follow the instructions [here](/SECURITY.md#reporting-a-vulnerability).
52 -
53 -### Pull Requests & Code Reviews
54 -
55 -Please check the PR checklist in the [PR template](.github/PULL_REQUEST_TEMPLATE.md) for detailed guide for contribution.
56 -
57 -### Thank You
58 -
59 -Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM.
60 -All of your contributions help make vLLM a great tool and community for everyone!
3 +You may find information about contributing to vLLM on [docs.vllm.ai](https://docs.vllm.ai/en/latest/contributing/overview/).
docs/source/contributing/dockerfile/dockerfile.rst renamed
docs/source/contributing/overview.rst new
+70
@@ -0,0 +1,70 @@
1 +Contributing to vLLM
2 +=====================
3 +
4 +Thank you for your interest in contributing to vLLM! 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:
5 +
6 +- Identify and report any issues or bugs.
7 +- Request or add support for a new model.
8 +- Suggest or implement new features.
9 +- Improve documentation or contribute a how-to guide.
10 +
11 +We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also highly regarded and beneficial contributions.
12 +
13 +Finally, one of the most impactful ways to support us is by raising awareness about vLLM. Talk about it in your blog posts and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository!
14 +
15 +License
16 +-------
17 +
18 +See `LICENSE <https://github.com/vllm-project/vllm/tree/main/LICENSE>`_.
19 +
20 +Developing
21 +----------
22 +
23 +Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the `building from source <https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source>`_ documentation for details.
24 +
25 +Testing
26 +-------
27 +
28 +.. code-block:: bash
29 +
30 + pip install -r requirements-dev.txt
31 +
32 + # linting and formatting
33 + bash format.sh
34 + # Static type checking
35 + mypy
36 + # Unit tests
37 + pytest tests/
38 +
39 +.. note:: Currently, the repository does not pass the ``mypy`` tests.
40 +
41 +Contribution Guidelines
42 +=======================
43 +
44 +DCO and Signed-off-by
45 +----------------------
46 +
47 +When contributing changes to this project, you must agree to the `DCO <https://github.com/vllm-project/vllm/tree/main/DCO>`_.
48 +Commits must include a ``Signed-off-by:`` header which certifies agreement with
49 +the terms of the `DCO <https://github.com/vllm-project/vllm/tree/main/DCO>`_.
50 +
51 +Using ``-s`` with ``git commit`` will automatically add this header.
52 +
53 +Issues
54 +------
55 +
56 +If you encounter a bug or have a feature request, please `search existing issues <https://github.com/vllm-project/vllm/issues?q=is%3Aissue>`_ first to see if it has already been reported. If not, please `file a new issue <https://github.com/vllm-project/vllm/issues/new/choose>`_, providing as much relevant information as possible.
57 +
58 +.. important::
59 + If you discover a security vulnerability, please follow the instructions `here <https://github.com/vllm-project/vllm/tree/main/SECURITY.md#reporting-a-vulnerability>`_.
60 +
61 +Pull Requests & Code Reviews
62 +----------------------------
63 +
64 +Please check the PR checklist in the `PR template <https://github.com/vllm-project/vllm/tree/main/.github/PULL_REQUEST_TEMPLATE.md>`_ for a detailed guide for contribution.
65 +
66 +Thank You
67 +---------
68 +
69 +Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM.
70 +All of your contributions help make vLLM a great tool and community for everyone!
docs/source/contributing/profiling/profiling_index.rst renamed
docs/source/design/input_processing/input_processing_pipeline.rst renamed
docs/source/design/input_processing/model_inputs_index.rst renamed
docs/source/design/kernel/paged_attention.rst renamed
docs/source/design/multimodal/adding_multimodal_plugin.rst renamed
docs/source/design/multimodal/multimodal_index.rst renamed
docs/source/index.rst
+29 -10
@@ -130,26 +130,45 @@ Documentation
130
131 performance/benchmarks
132
133 +.. Community: User community resources
134 +
135 +.. toctree::
136 + :maxdepth: 1
137 + :caption: Community
138 +
139 + community/meetups
140 + community/sponsors
141 +
142 +.. API Documentation: API reference aimed at vllm library usage
143 +
144 .. toctree::
145 :maxdepth: 2
135 - :caption: Developer Documentation
146 + :caption: API Documentation
147
148 dev/sampling_params
149 dev/pooling_params
150 dev/offline_inference/offline_index
151 dev/engine/engine_index
141 - dev/kernel/paged_attention
142 - dev/input_processing/model_inputs_index
143 - dev/multimodal/multimodal_index
144 - dev/dockerfile/dockerfile
145 - dev/profiling/profiling_index
152 +
153 +.. Design: docs about vLLM internals
154
155 .. toctree::
148 - :maxdepth: 1
149 - :caption: Community
156 + :maxdepth: 2
157 + :caption: Design
158
151 - community/meetups
152 - community/sponsors
159 + design/input_processing/model_inputs_index
160 + design/kernel/paged_attention
161 + design/multimodal/multimodal_index
162 +
163 +.. Contributing: contributing to the vLLM project
164 +
165 +.. toctree::
166 + :maxdepth: 2
167 + :caption: Contributing
168 +
169 + contributing/overview
170 + contributing/profiling/profiling_index
171 + contributing/dockerfile/dockerfile
172
173 Indices and tables
174 ==================