Missing or outdated README / documentation

[ishika24755]

Description

The RenAIssance repository currently lacks a complete README and proper documentation. This makes it difficult for new users and contributors to:

• Install required dependencies
• Download and prepare datasets
• Run training or evaluation scripts
• Understand expected outputs and workflow

Proposed Solution

• Add a full README.md with:
  • Installation instructions (Python version, dependencies)
  • Dataset download instructions and paths
  • Usage examples (training, inference, evaluation)
  • Expected outputs and example results
• Optionally, add a docs/ folder for extended documentation (dataset details, model architecture, etc.)

Why This Is Important

Improving documentation will make the project usable and approachable for new contributors, reduce setup errors, and improve adoption.

[ishika24755]

Hi,

I’d like to contribute to the RenAIssance repository by improving the README and documentation. I plan to create a quick PR with detailed installation instructions, dataset setup, usage examples, and expected outputs.

Please let me know if there are any specific guidelines I should follow for the documentation.

[ridham2890052-rgb]

Hi! I’m a GSoC 2026 aspirant. I’ve been working on setting up the environment today and ran into a few hurdles that I’ve already managed to resolve.

Specifically, I found some version conflicts with torchaudio on Windows/CUDA 12.4 and noticed several missing dependencies (like pymupdf, python-docx, and tensorflow) that are required to run the Dataset_Generation.ipynb notebook.

I’d love to contribute by adding a dedicated 'Windows Setup & Troubleshooting' section to the README based on these fixes so other contributors don't run into the same 'Import not resolved' errors. I have already prepared a PR to update the requirements.txt as well!