docs: add CLAUDE.md and agent_docs for AI-assisted development#17770
Draft
scyyh11 wants to merge 8 commits intoPaddlePaddle:mainfrom
Draft
docs: add CLAUDE.md and agent_docs for AI-assisted development#17770scyyh11 wants to merge 8 commits intoPaddlePaddle:mainfrom
scyyh11 wants to merge 8 commits intoPaddlePaddle:mainfrom
Conversation
Add concise CLAUDE.md with project overview, build/verify commands, architecture map, and 3.x API guidance. Detailed inference and training docs live in agent_docs/ for progressive disclosure.
|
Thanks for your contribution! |
Bobholamovic
reviewed
Mar 5, 2026
agent_docs/inference_api.md
Outdated
|
|
||
| ## Available Pipelines | ||
|
|
||
| All imported from `paddleocr`: |
Member
There was a problem hiding this comment.
这些内容可能频繁变化，是否意味着可能经常更新。如果这里的指示和实际情况适配，怎么办？我想是否可以告诉AI一个可靠的方式获取产线信息，或者通过某种自动化机制监测，确保新增/改动产线时一定要修改这个位置。
agent_docs/inference_api.md
Outdated
|
|
||
| | Model | Purpose | | ||
| |-------|---------| | ||
| | `TextDetection` | Detect text regions | |
| @@ -0,0 +1,38 @@ | |||
| # CLAUDE.md | |||
Member
There was a problem hiding this comment.
感觉内容还可以再丰富一些，可以参考这里获取更多灵感：https://github.com/langchain-ai/langchain/blob/master/AGENTS.md
…for pipelines/models - CLAUDE.md: add project structure tree, code style conventions, testing guidance, PR guidelines, and dynamic discovery section (inspired by langchain AGENTS.md) - inference_api.md: replace hardcoded pipeline/model tables with instructions to read __all__ from source __init__.py files, avoiding staleness when pipelines/models are added or removed
scyyh11
force-pushed
the
docs/add-claude-md-and-agent-docs
branch
from
80dd6ed to
f8f9c97
Compare
- New agent_docs/config_system.md covering YAML config structure, CLI overrides, architecture composition, optimizer/LR schedulers, dataset/transform pipelines, and builder flow - Update CLAUDE.md and AGENTS.md to reference the new doc
- Remove Claude-specific references from AGENTS.md - Slim down CLAUDE.md to just link to AGENTS.md for easier maintenance
| @@ -0,0 +1,213 @@ | |||
| # Config System | |||
Member
There was a problem hiding this comment.
这里主要介绍的其实是traning的config，是否需要和inference的区分一下？inference的config其实就是paddlex的config格式了
…tem.md Address PR review feedback — the config doc previously only covered training configs. Now clearly separates into Part 1 (Training Config) and Part 2 (Inference Config / PaddleX), since they are two unrelated systems.
Add contribution policy (duplicate-work checks, no-busywork rule, accountability), expand build instructions into detailed development workflow with environment setup, test commands, and linter usage, and reorganize into numbered sections.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add concise CLAUDE.md with project overview, build/verify commands, architecture map, and 3.x API guidance. Detailed inference and training docs live in agent_docs/ for progressive disclosure.