project-understanding

Generate a source.md map of entry points, training loop, and eval harness.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/ZhangHanbo/alpha_research --skill project-understanding-zhanghanbo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-understanding
Source: https://github.com/ZhangHanbo/alpha_research/tree/main/skills/project-understanding
Command: npx skills add https://github.com/ZhangHanbo/alpha_research --skill project-understanding-zhanghanbo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Walk the researcher's method-code directory and produce a living source.md that maps entry points, the method module, the training loop, the eval harness, and the formalization↔code correspondence. It is used when code_dir is set on a project and source.md is missing or stale, typically on DIAGNOSE entry or after significant code changes.

Core Features & Use Cases

  • Inventory and map the project structure to identify key entry points like train.py, eval.py, and main modules.
  • Trace the training loop, data interfaces, and evaluation harness to build a coherent source.md.
  • Compare the formalization.md objectives with the actual code to surface gaps and guide debugging.

Quick Start

Run the project-understanding skill on a project with a configured code_dir to generate source.md.

Frequently Asked Questions about project-understanding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I map a project's code directory structure and generate a source understanding file?

To map a project's code directory structure and generate a source understanding file, the skill walks the configured code_dir to inventory entry points like train.py and eval.py, outputting a detailed source.md map.

What is the best way to trace the training loop and evaluation harness in a machine learning codebase?

Tracing the training loop and evaluation harness involves analyzing the code tree at code_dir to identify data interfaces and key modules, which this skill compiles into a coherent source.md document for the project.

How does formalization code correspondence work for diagnosing project issues?

Formalization code correspondence compares the formalization.md objectives with the actual code implementation to surface gaps and guide debugging, particularly useful during the DIAGNOSE entry phase after major code changes.

Do I need a state.json file to extract entry points and method modules from my code?

Yes, you need a state.json file with a configured code_dir, along with project.md and formalization.md, to extract entry points, the method module, the training loop, and the evaluation harness into source.md.

When should I regenerate the source map for my code project?

You should regenerate the source map when source.md is missing or outdated, particularly when entering a DIAGNOSE phase or after making significant code changes that affect the project's method module or training loop.

Can I identify key entry points like train.py and eval.py automatically from my code tree?

Yes, you can automatically identify key entry points like train.py and eval.py by running this skill on a project with a configured code_dir, which inventories the structure and maps the method module into source.md.