Getting Started

Getting Started with contributing to the project.

1. Getting familiar with the tools:

• We will be using Hydra for configuration management. The framework has been created and actively maintained by facebookresearch team, and provides an easy and clean way to manage the configurations for a project (compared to argparse). A good getting started video tutorial can be found on ArjanCodes' youtube channel.
• For experiment tracking, we will be using Weights and baises. It is a simple tool to track and visualise experiments. One can use their documentation to get started.

2. Tools and practices for writing better code:

• We will be using autoDocstring plugin in VS Code to help us write better documentations. We will be using numpy format for writing docs.
• We will be using the similar project directory structure as done in lab2. The idea is the follow the separation of concerns principle, and club the files in different directories that serve different purpose.
• We will be adding type hints in the code wherever possible. this makes code easy to understand to others.
• we will be following other good practices while writing code, eg. limiting line to 70 chars (not too strict though), naming variables and functions carefully, making sure a function does one and only one thing, preferring OOPs over functions wherever feasible.

3. Collaborating effectively:

• We will be writing unit tests for the part of code that we commit. This would ensure that other's changes to code does not break the existing codebase accidently.
• We will be working on different branches on git, and create pull request to the master branch, rather than directly pushing to the master branch.