Manual for Coders to Write Algorithms for PAMI Library

Chapter 1: Basics

1. Organization of algorithms in PAMI
2. Inputs and outputs of an algorithm
3. Methods to execute an algorithm in PAMI
4. Casing style to be followed
5. Using Abstract Base Class (ABC)
6. Need for main method
7. Documentation techniques

Chapter 2: Writing Algorithms

1. Location to place an algorithm in PAMI
2. Creation of Abstract class
3. Coding an algorithm
4. Profiling/Code optimization (under development)
5. Testing procedure an algorithm (under development)

Note:

• Do not create unnecessary variables.
• Use proper names for the variables. Do not name the variables randomly, such as i, j, and k.

Chapter 3: Documentation

1. Description of an algorithm (under development)
2. Defining the inputs and outputs of an algorithm (under development)
3. Citation of the corresponding paper (under development)
4. Describing the methods of an algorithm (under development)
5. Creation of HTML files (under development)

Chapter 4: PYPI repository (coming soon)