Documentation overview#
Note
If you haven’t already installed AVNI, please take a look at our installation guides. Please also kindly find some resources for Getting started with Python if you need to.
The documentation for AVNI is divided into three main sections:
The API reference provides documentation for the classes, functions and methods in the AVNI codebase. This is the same information that is rendered when running
help(avni.<function_name>)in an interactive Python session, or when typingavni.<function_name>?in an IPython session or Jupyter notebook.The frequenty asked questions (FAQ) provides answers to several common questions about the AVNI codebase. Feel feel free to reach out to us to get more help
Important
Checkout the project governance, design philosophy and code of conduct pages for a broad overview of the project expectations and outlook.