Pull Request Details:

[dabadav]

This pull request includes two main changes:

1. Documentation generation: Sphinx has been used to generate the documentation for the project. This will make the project more understandable and easier for others to use.

2. Package and dependency management: The poetry.toml file has been added to manage the package and its dependencies. This file will make the installation process much easier for both users and developers. They can use Poetry to install the package and automatically handle its dependencies.

Modules

The project includes the following Python modules:

• io: Handles the input/output operations.
• linear_dim_red: Includes functions for linear dimensionality reduction.
• session: Handles whole dataset.
• utils: Includes various utility functions.
• vae: Contains the code related to Variational Autoencoders.
• visualization: Consists of the visualization functions.

TODO

There are still some improvements that need to be done:

1. linear_dim_red module: More functions need to be added to this module, as there are some missing ones.
2. Renaming session to embeddings: The current session module should be called embeddings.
3. Creating a proper session module: A proper session module should be created to handle vsdi session data using a class.
4. utils module renaming: This module should be the preprocessing one. So functions inside this module need to be reviewed.
5. Merge dimensionality reduction methods: All the dimensionality reduction methods should be moved to a single submodule.