research-code-quality

Validates research experiment code contracts, config-driven skeletons, and remote GPU run templates.

2|Updated May 22, 2026
One-click install
npx skills add https://github.com/CDUTAKL/research-workflow-kit --skill research-code-quality-cdutakl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: research-code-quality
Source: https://github.com/CDUTAKL/research-workflow-kit/tree/main/skills/research-code-quality
Command: npx skills add https://github.com/CDUTAKL/research-workflow-kit --skill research-code-quality-cdutakl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Research code often contains hard-coded paths, missing seeds, and undocumented configs that make experiments irreproducible and thesis claims unverifiable. This Skill enforces experiment contracts, smoke tests, and machine-readable output manifests before expensive GPU runs. ## Core Features & Use Cases - Experiment Contract Validation: Checks that every formal run has a config, seed, split, metric, output path, registry row, and smoke config via check_experiment_contract.py. - Project Skeleton Generation: Renders a standard src/configs/tests layout with render_project_skeleton.py for new research projects. - Remote GPU Run Templates: Provides sync/run/fetch/archive templates for a remote 4060 desktop and AutoDL fallback with environment snapshots, checksums, and auto-shutdown. - Use Case: Before launching an overnight training run on a remote 4060 GPU, use this Skill to verify the experiment contract, generate an environment snapshot, and confirm the output manifest will contain metrics, logs, and resolved config. ## Quick Start Use the research-code-quality skill to check my experiment code and config contract before I start GPU training.

Frequently Asked Questions about research-code-quality

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

FAQPage Schema
How do I validate an experiment contract before GPU training?

Run check_experiment_contract.py with the experiment ID, config path, smoke config, and registry file. Add --require-outputs after a run to require manifest.json, config_resolved.json, metrics.json, and logs, and --require-env-snapshot for formal remote GPU runs.

How to make research experiment code reproducible?

Use config-driven entrypoints for train, evaluate, predict, and figures instead of hard-coded paths, seeds, and metrics. Every formal run should record a contract with config, seed, split, metric, output path, and a registry row, plus an environment snapshot for GPU evidence.

What project structure should a research codebase use?

The recommended skeleton separates src/data, src/models, src/training, src/evaluation, src/metrics, and src/utils, with configs/experiment, configs/smoke, scripts/figures, and tests directories. Generate it with render_project_skeleton.py.

Can I run formal experiments on AutoDL cloud GPU instances?

Yes, AutoDL fallback templates support sync, run with auto-shutdown, and result fetching over SSH alias. The run template writes train.log, exit code, environment snapshot, checksums, and a run summary before shutting down, and never stores passwords or account details.

Why do remote GPU run templates refuse to store credentials?

The templates only store SSH aliases, paths, and commands because embedding passwords, tokens, or private keys in project files creates credential leakage risks. Authentication is delegated to the user's local SSH configuration.