You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contribute/community.rst
+55-18
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,24 @@ MLC-LLM Community Guidelines
7
7
:depth: 2
8
8
:local:
9
9
10
-
Welcome to the MLC-LLM community! Just like you, all of us are in awe of the immense power of large language models. Our goal for MLC-LLM is to foster a project that is driven by an open-source community, working together to democratize this technology and make it accessible across various devices. We are thrilled to have you as part of our community and eagerly anticipate your valuable contributions.
10
+
Welcome to the MLC-LLM community! Just like you, all of us are in awe of the immense power of large language models.
11
+
Our goal for MLC-LLM is to foster a project that is driven by an open-source community, working together to democratize
12
+
this technology and make it accessible across various devices. We are thrilled to have you as part of our
13
+
community and eagerly anticipate your valuable contributions.
11
14
12
15
13
16
.. _community_discussion:
14
17
15
18
Participate in Community Discussions
16
19
------------------------------------
17
20
18
-
We encourage open discussions. If you encounter a bug or have a feature request, please file an issue in MLC-LLM's GitHub `issue tracker <https://github.com/mlc-ai/mlc-llm/issues>`__. You are encouraged to tag the issue with labels such as "bug," "feature request," or "iOS" so that the relevant developers can quickly notice your concern.
21
+
We encourage open discussions. If you encounter a bug or have a feature request, please file an issue in MLC-LLM's
22
+
GitHub `issue tracker <https://github.com/mlc-ai/mlc-llm/issues>`__. You are encouraged to tag the issue with labels
23
+
such as "bug," "feature request," or "iOS" so that the relevant developers can quickly notice your concern.
19
24
20
-
Additionally, we have set up a `discord server <https://discord.gg/9Xpy2HGBuD>`__ for online discussions. While we encourage participation in the Discord server, we also recommend creating a GitHub issue even if the topic has been discussed there. This ensures that the discussion is archived and searchable for future reference.
25
+
Additionally, we have set up a `discord server <https://discord.gg/9Xpy2HGBuD>`__ for online discussions.
26
+
While we encourage participation in the Discord server, we also recommend creating a GitHub issue even if the
27
+
topic has been discussed there. This ensures that the discussion is archived and searchable for future reference.
21
28
22
29
Before submitting an issue, we kindly ask you to check our `FAQ page :doc:/misc/` to see if your question has already been answered.
23
30
@@ -31,11 +38,15 @@ Contribute to MLC-LLM
31
38
Fork and Create Pull Requests
32
39
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
40
34
-
Ready to contribute to MLC-LLM? Awesome! We are excited to see you are ready to contribute your code. The standard way to make changes to MLC-LLM code base is through creating a `pull-request <https://github.com/mlc-ai/mlc-llm/pulls>`__, and we will review your code and merge it to the code base when it is ready.
41
+
Ready to contribute to MLC-LLM? Awesome! We are excited to see you are ready to contribute your code.
42
+
The standard way to make changes to MLC-LLM code base is through creating a `pull-request <https://github.com/mlc-ai/mlc-llm/pulls>`__,
43
+
and we will review your code and merge it to the code base when it is ready.
35
44
36
-
The first step to become a developer is to `fork <https://github.com/mlc-ai/mlc-llm/fork>`__ the repository to your own github account, you will notice a repository under ``https://github.com/username/mlc-llm`` where ``username`` is your github user name.
45
+
The first step to become a developer is to `fork <https://github.com/mlc-ai/mlc-llm/fork>`__ the repository to your own
46
+
github account, you will notice a repository under ``https://github.com/username/mlc-llm`` where ``username`` is your github user name.
37
47
38
-
You can clone your fork to your local machine and commit changes, or edit the contents of your fork (in the case you are just fixing typos) on github directly. Once your update is complete, you can click the ``contribute`` button and open a pull request to the main repository.
48
+
You can clone your fork to your local machine and commit changes, or edit the contents of your fork (in the case you are just fixing typos)
49
+
on github directly. Once your update is complete, you can click the ``contribute`` button and open a pull request to the main repository.
39
50
40
51
.. _contribute-new-models:
41
52
@@ -44,51 +55,77 @@ Contribute New Models to MLC-LLM
44
55
45
56
Woohoo! Congratulations
46
57
47
-
* If you compiled a model for existing model architecture by following our :doc:`../tutorials/compile-models` tutorial. Please upload your model stored in ``dist`` directory to Hugging Face (an example can be found `here <https://huggingface.co/mlc-ai/mlc-chat-vicuna-v1-7b-q4f32_0/tree/main>`__), and please create a pull request to MLC-LLM and add your model code to the `model zoo <https://github.com/mlc-ai/mlc-llm/tree/main/docs/model-zoo.rst>`__, and create a issue to track the speed and memory consumption of your model, see an example `here <https://github.com/mlc-ai/mlc-llm/issues/15>`__ (you don't need to test on all devices, let the community build it together!).
48
-
* If you add a new model variant to MLC-LLM by following our :doc:`../tutorials/bring-your-own-models` tutorial. Please create a pull request to add your model architecture (currently model architectures are placed under `relax_models <https://github.com/mlc-ai/mlc-llm/tree/main/mlc_llm/relax_model>`__ folder).
58
+
* If you compiled a model for existing model architecture by following our :doc:`../tutorials/compile-models` tutorial.
59
+
Please upload your model stored in ``dist`` directory to Hugging Face (an example can be
60
+
found `here <https://huggingface.co/mlc-ai/mlc-chat-vicuna-v1-7b-q4f32_0/tree/main>`__), and please create a
61
+
pull request to MLC-LLM and add your model code to the `model zoo <https://github.com/mlc-ai/mlc-llm/tree/main/docs/model-zoo.rst>`__,
62
+
and create a issue to track the speed and memory consumption of your model, see an example `here <https://github.com/mlc-ai/mlc-llm/issues/15>`__
63
+
(you don't need to test on all devices, let the community build it together!).
64
+
* If you add a new model variant to MLC-LLM by following our :doc:`../tutorials/bring-your-own-models` tutorial.
65
+
Please create a pull request to add your model architecture (currently model architectures are placed under
For python codes, we generally follow the `PEP8 style guide <https://peps.python.org/pep-0008/>`__. The python comments follow `NumPy style <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>`__ python docstrings. To make things easy, you can use `black <https://pypi.org/project/black/>`__ to automatically format your python code.
73
+
For python codes, we generally follow the `PEP8 style guide <https://peps.python.org/pep-0008/>`__.
74
+
The python comments follow `NumPy style <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>`__ python docstrings.
75
+
To make things easy, you can use `black <https://pypi.org/project/black/>`__ to automatically format your python code.
56
76
57
77
.. code:: bash
58
-
78
+
59
79
pip install black
60
80
black your_python_file.py
61
81
62
-
For C++ codes, we generally follow the `Google C++ style guide <https://google.github.io/styleguide/cppguide.html>`__. The C++ comments should be `Doxygen compatible <http://www.doxygen.nl/manual/docblocks.html#cppblock>`__. Fo your convenience, you can use `clang-format <https://clang.llvm.org/docs/ClangFormat.html>`__ to automatically format your C++ code.
82
+
For C++ codes, we generally follow the `Google C++ style guide <https://google.github.io/styleguide/cppguide.html>`__.
83
+
The C++ comments should be `Doxygen compatible <http://www.doxygen.nl/manual/docblocks.html#cppblock>`__.
84
+
Fo your convenience, you can use `clang-format <https://clang.llvm.org/docs/ClangFormat.html>`__ to automatically format your C++ code.
63
85
64
86
.. code:: bash
65
-
87
+
66
88
clang-format -i your_cpp_file.cpp
67
89
68
90
.. _general-development-process:
69
91
70
92
General Development Process
71
93
---------------------------
72
94
73
-
Everyone in the community is welcomed to send patches, documents, and propose new directions to the project. The key guideline here is to enable everyone in the community to get involved and participate the decision and development. When major changes are proposed, an RFC (Request for Comments) should be sent to allow discussion by the community. We encourage public discussion, archivable channels such as github issues, so that everyone in the community can participate and review the process later.
95
+
Everyone in the community is welcomed to send patches, documents, and propose new directions to the project.
96
+
The key guideline here is to enable everyone in the community to get involved and participate the decision and development.
97
+
We encourage public discussion in different channels, so that everyone in the community can participate
98
+
and get informed in developments.
74
99
75
-
Code reviews are one of the key ways to ensure the quality of the code. High-quality code reviews prevent technical debt for long-term and are crucial to the success of the project. A pull request needs to be reviewed before it gets merged. A committer who has the expertise of the corresponding area would moderate the pull request and the merge the code when it is ready. The corresponding committer could request multiple reviewers who are familiar with the area of the code. We encourage contributors to request code reviews themselves and help review each other's code -- remember everyone is volunteering their time to the community, high-quality code review itself costs as much as the actual code contribution, you could get your code quickly reviewed if you do others the same favor.
100
+
Code reviews are one of the key ways to ensure the quality of the code. High-quality code reviews prevent technical debt
101
+
for long-term and are crucial to the success of the project. A pull request needs to be reviewed before it gets merged.
102
+
A committer who has the expertise of the corresponding area would moderate the pull request and the merge the code when
103
+
it is ready. The corresponding committer could request multiple reviewers who are familiar with the area of the code.
104
+
We encourage contributors to request code reviews themselves and help review each other's code -- remember everyone
105
+
is volunteering their time to the community, high-quality code review itself costs as much as the actual code
106
+
contribution, you could get your code quickly reviewed if you do others the same favor.
76
107
77
-
The community should strive to reach a consensus on technical decisions through discussion. We expect committers to moderate technical discussions in a diplomatic way, and provide suggestions with clear technical reasoning when necessary.
108
+
The community should strive to reach a consensus on technical decisions through discussion. We expect committers to
109
+
moderate technical discussions in a diplomatic way, and provide suggestions with clear technical reasoning when necessary.
78
110
79
111
80
112
.. _roles-committers:
81
113
82
114
Committers
83
115
^^^^^^^^^^
84
116
85
-
Committers are individuals who are granted the write access to the project. A committer is usually responsible for a certain area or several areas of the code where they oversee the code review process.
117
+
Committers are individuals who are granted the write access to the project. A committer is usually responsible for
118
+
a certain area or several areas of the code where they oversee the code review process.
86
119
The area of contribution can take all forms, including code contributions and code reviews, documents, education, and outreach.
87
120
The review of pull requests will be assigned to the committers who recently contribute to the area this PR belong to.
88
-
Committers are essential for a high quality and healthy project. The community actively look for new committers from contributors. Each existing committer can nominate new committers to MLC-LLM.
121
+
Committers are essential for a high quality and healthy project. The community actively look for new committers
122
+
from contributors. Each existing committer can nominate new committers to MLC projects.
89
123
90
124
.. _roles-contributors:
91
125
92
126
Contributors
93
127
^^^^^^^^^^^^
94
-
We also welcome contributors if you are not ready to be a committer yet. Everyone who contributes to the project (in the form of code, bugfix, documentation, tutorials, etc) is a contributors. We maintain a `page <https://github.com/mlc-ai/mlc-llm/blob/master/CONTRIBUTORS.md>`__ to acknowledge contributors, please let us know if you contribute to the project and your name is not included in the list.
128
+
We also welcome contributors if you are not ready to be a committer yet. Everyone who contributes to
129
+
the project (in the form of code, bugfix, documentation, tutorials, etc) is a contributors.
130
+
We maintain a `page <https://github.com/mlc-ai/mlc-llm/blob/main/CONTRIBUTORS.md>`__ to acknowledge contributors,
131
+
please let us know if you contribute to the project and your name is not included in the list.
0 commit comments