How to Contribute¶
Git Repo and Issue Tracking¶
GitHub starsAmpliGraph repository is available on GitHub.
A list of open issues is available here.
The AmpliGraph Slack channel is available here.
How to Contribute¶
We welcome community contributions, whether they are new models, tests, or documentation.
You can contribute to AmpliGraph in many ways:
- Raise a bug report
- File a feature request
- Help other users by commenting on the issue tracking system
- Add unit tests
- Improve the documentation
- Add a new graph embedding model (see below)
Adding Your Own Model¶
The landscape of knowledge graph embeddings evolves rapidly. We welcome new models as a contribution to AmpliGraph, which has been built to provide a shared codebase to guarantee a fair evalaution and comparison acros models.
You can add your own model by raising a pull request.
To get started, read the documentation on how current models have been implemented.
Clone and Install in editable mode¶
Clone the repository and checkout the develop branch.
Install from source with pip. use the -e flag to enable editable mode:
git clone https://github.com/Accenture/AmpliGraph.git
git checkout develop
cd AmpliGraph
pip install -e .
Unit Tests¶
To run all the unit tests:
$ pytest tests
See pytest documentation for additional arguments.
Documentation¶
The project documentation is based on Sphinx and can be built on your local working copy as follows:
cd docs
make clean autogen html
The above generates an HTML version of the documentation under docs/_built/html.
Packaging¶
To build an AmpliGraph custom wheel, do the following:
pip wheel --wheel-dir dist --no-deps .