text
stringlengths
0
9.36M
### 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][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
File: CONTRIBUTING.md
Contents:
# Contributing to AdapterHub
There are many ways in which you can contribute to AdapterHub and the `adapter-transformers` library.
This includes code contributions such as:
- implementing new adapter methods
- adding support for new Transformer
- fixing open issues
as well as non-code contributions such as:
- training and uploading adapters to the Hub
- writing documentation and blog posts
- helping others with their issues and questions
Whichever way you'd like to contribute, you're very welcome to do so!
## Contributing to the `adapter-transformers` codebase
To get started with writing code for `adapter-transformers`, you'd want to set up the project on a local/ development environment.
`adapter-transformers` closely follows the original HuggingFace Transformers repository in many aspects.
As they already provide a great guide on setting up the project and the general contribution process, we refer to [their contributing guide](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md) here.
Some additional notes are given below.
`adapter-transformers` uses the same code quality checks as HuggingFace Transformers.
Therefore, make sure to pass all the tests run using
```bash
$ make quality
```
to pass our CI pipeline.
Besides the commands for formatting, style checking and testing mentioned in the HuggingFace contributing guide, you can run all tests specific to `adapter-transformers` as follows:
```bash
$ make test-adapters
```
This corresponds to the tests run in our CI pipeline.
Below we refer to more detailed explanations of some typical contribution scenarios.
### Adding Adapter Methods
How to integrate new efficient fine-tuning/ adapter methods to `adapter-transformers` is described at [https://docs.adapterhub.ml/contributing/adding_adapter_methods.html](https://docs.adapterhub.ml/contributing/adding_adapter_methods.html).
### Adding Adapters to a Model
How to add adapter support to a model type already supported by HuggingFace Transformers is described at [https://docs.adapterhub.ml/contributing/adding_adapters_to_a_model.html](https://docs.adapterhub.ml/contributing/adding_adapters_to_a_model.html).
## Contributing Adapters to the Hub