[TAO-2523][Docs] Refresh developer docs: codebase tour, deeper architecture, GitHub-era CI - #40
Open
vpraveen-nv wants to merge 2 commits into
Open
[TAO-2523][Docs] Refresh developer docs: codebase tour, deeper architecture, GitHub-era CI#40vpraveen-nv wants to merge 2 commits into
vpraveen-nv wants to merge 2 commits into
Conversation
…ecture, GitHub-era CI Bring the developer docs to parity with tao-pytorch's docs tree and address feedback that the repo structure, modules, and architecture are hard for new developers to pick up: - Add docs/codebase_tour.md: annotated repo tree, package module map, hydra vs proto family inventory, anatomy of the dino family, and a consolidated sharp-edges list (config_name divergences, workspace_size units, subprocess launch, model_agnostic limits, UFF status, submodule requirement). - Expand docs/architecture.md: the three entrypoint styles, config field factories and metadata, a config_name divergence audit table, the layered TensorRT runtime, the tao-core boundary, and the cross-repo contract with tao-pytorch. - Add docs/assets/config_flow.svg and module_map.svg in the same style as tao-pytorch's diagrams. - Refresh agent_onboarding, development_workflows, testing_and_debugging, and index: remove stale .gitlab-ci.yml / ci/run_static_tests.py / Jenkinsfile references and document the pre-commit + GitHub Actions checks that actually run; correct base-image digest bump locations (manifest + release Dockerfile ARG defaults); point backend-integration validation at pre-commit and the clip/video_clip test template. - Apply the TAO documentation style guide to the new and touched pages. All paths, class names, config_name values, and CI behavior verified against source at origin/main. Signed-off-by: Varun Praveen <vpraveen@nvidia.com>
|
For security reasons, CI does not run automatically on NVIDIA's runners — it must be triggered per commit.
Tip Should this fix also ship in a release? Add a Important Before merging: every file needs a license header and every commit must be DCO signed-off — see the 📖 Contribution guide for details. |
Address developer review feedback on the docs refresh: - Architecture no longer opens with the development container launcher. New opening sections explain what the product is (the container it ships as and its user-facing console commands) and how customers run it as of TAO 7.0 (agent + tao-skills + Execution SDK over the container CLI), with the removed TAO Launcher and FTMS surfaces called out explicitly as history and in-repo remnants labeled as legacy integration surfaces. - New Terminology section defining service/model family, subtask, specification, the shared command dispatcher, and the dev-only container launcher - and explicitly disambiguating them from the removed TAO Launcher. - New Test Environment Setup section: submodule init, dev container entry, pip install tao-core/. (the step the README missed), PYTHONPATH notes, and which suites need GPUs or private datasets. - Terminology sweep: 'launcher' now refers only to the dev container tool; the in-repo dispatch code is the 'shared command dispatcher'. Consumption-mode statements verified against the public docs source (release_notes.rst 'Removed in 7.0', migrating_to_tao_7.0.rst, overview.rst deployment-modes table). Signed-off-by: Varun Praveen <vpraveen@nvidia.com>
Contributor
Author
|
Applied the same review feedback raised on the data-services PR: architecture now opens with product context (what ships, how customers run it as of TAO 7.0) instead of the dev container launcher; added a Terminology section disambiguating subtask/specification/dispatcher/dev-launcher from the removed TAO Launcher and FTMS; added a Test Environment Setup section (submodule init + |
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
1 participant
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.
Brings the tao-deploy developer docs to parity with tao-pytorch's docs tree and addresses feedback that the repo structure, modules, and architecture are hard for new developers to pick up.
What changed
docs/codebase_tour.md— annotated repo tree, package module map, hydra-vs-proto family inventory, anatomy of thedinofamily, and a consolidated sharp-edges list (config_name divergences,workspace_sizeunits, subprocess launch,model_agnosticlimits, UFF status on TRT >= 9, submodule requirement).docs/architecture.md— the three entrypoint styles, config field factories and metadata, a config_name divergence audit table, the layered TensorRT runtime, the tao-core boundary, and the cross-repo contract with tao-pytorch.config_flow.svg,module_map.svg) in the same style as tao-pytorch's..gitlab-ci.yml/ci/run_static_tests.py/ Jenkinsfile references; documented the pre-commit + GitHub Actions checks that actually run; corrected base-image digest bump locations (manifest + release Dockerfile ARG defaults).Verification
config_namevalue cross-checked against source at origin/main.python tools/update_docs_supported_commands.py --checkpasses;git diff --checkclean; SVGs are valid XML; all relative doc links resolve.JIRA: TAO-2523