Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
Table of Contents
- Types of Contributions
- Local development environment
- Pull Request Guidelines
Types of Contributions¶
Report bugs through Github issue.
Please report relevant information and preferably code that exhibits the problem.
Look through the Github issue for bugs. Anything is open to whoever wants to implement it.
Remember, 100% Tensorflow, no Keras.
Or, you can simply email your data if you do not want to expose the data to public. Malaya will not exposed your data, but we will exposed our trained models based on your data.
Malaya could always use better documentation, might have some typos or uncorrect object names.
The latest API documentation is usually available here. To generate a local version,
pip install readthedocs cd docs bash generate_template.sh
Local development environment¶
When you develop Malaya you can create local
virtualenv with all
requirements required by Malaya.
Advantage of local installation is that everything works locally, you do
not have to enter Docker/container environment and you can easily debug
the code locally. You can also have access to python
contains all the necessary requirements and use it in your local IDE -
this aids autocompletion, and running tests directly from within the
The disadvantage is that you have to maintain your dependencies and local environment consistent with other development environments that you have on your local machine.
It’s also very difficult to make sure that your local environment is consistent with other environments. This can often lead to “works for me” syndrome. It’s better to use the Docker Compose integration test environment in case you want reproducible environment consistent with other people.
Install Python (3.6 and above) by using system-level package managers like yum, apt-get for Linux, or Homebrew for Mac OS at first.
Pull Request Guidelines¶
Before you submit a pull request from your forked repo, check that it meets these guidelines:
- The pull request should include step-by-step if the request is
- Please rebase your fork, squash commits, and resolve all conflicts.
- The pull request should work for Python 3.6 and above.
- As Malaya grows as a project, we try to enforce a more consistent style and try to follow the Python community guidelines. We currently enforce to use BlackMamba for code standard.