Contributing for AdaptNLP
To contribute to the AdaptNLP library first make sure you are familiar with the nbdev framework.
The library is built by the notebooks available in the
nbs folder, and tests can be run by using
We follow a special documentation schema based on docments where each param is documented with a comment block next to it, such as below:
def add( a:int, # The first number to add b:float # The second number to add ) -> (int, float): # The sum of `a` and `b` "Adds two numbers together" return a+b
Please include tests for your functionality in the notebook cells below each function declaration.