Gen Week Report

Generation Process

1. Read Exercise PDF

• Locate the PDF for the exercise (e.g., ExerciseX.Y/ExerciseX.Y.pdf)
• Extract questions, instructions, and relevant context

2. Analyze Code

• Review all scripts in the exercise's src/ directory
• Identify main algorithms, models, and workflow
• Summarize implementation details and results

3. Compile Report

• Answer exercise questions from the PDF
• Summarize code logic, results, and insights
• Highlight any challenges or unique solutions
• Include relevant images from the outputs folder (e.g., outputs/example.png, outputs/forward.png, outputs/reverse.png) in both Markdown and LaTeX reports.

4. Format Files

• week_report/README.md: Markdown summary, organized by question and topic, with image references.
• .tex file: 1-page academic summary, formatted for clarity and brevity, with image inclusion using \includegraphics.

5. Update Strategy

• If the PDF, code, or outputs change, regenerate or update both files.
• Keep only current exercise content; remove outdated sections.
• Ensure the .tex file is exactly 1 page (use \newpage or adjust content as needed).

File Structure

# [Exercise Name] - Weekly Report

## Summary
Brief overview of the exercise and its goals.

## Key Questions & Answers
- Q1: ...
  - A1: ...
- Q2: ...
  - A2: ...

## Code Insights
- Main algorithms and models
- Results and findings
- Challenges and solutions

% [Exercise Name] - Weekly Report
\documentclass[12pt]{article}
\usepackage{amsmath,graphicx}
\begin{document}
\section*{Summary}
% Brief summary here

\section*{Key Questions & Answers}
% Q&A here

\section*{Code Insights}
% Algorithms, results, challenges

\end{document}

Validation

Before finalizing week_report/README.md and .tex:

1. Verify all questions from the PDF are answered
2. Ensure code analysis is accurate and concise
3. Confirm the .tex file compiles to exactly 1 page
4. Remove any outdated or irrelevant content