docs(seo): PyTorch-Wildlife content depth + long-tail (framework/model-zoo lane)#16
Open
rain-Brian wants to merge 2 commits into
Open
docs(seo): PyTorch-Wildlife content depth + long-tail (framework/model-zoo lane)#16rain-Brian wants to merge 2 commits into
rain-Brian wants to merge 2 commits into
Conversation
…l-zoo lane) Deepen homepage, installation, and model zoo and add API overview + inference examples pages. Standardize prose on 'conservation deep learning framework'; add keyword-first front-matter, model-zoo H1, cross-links to ecosystem siblings as modality owners, and a hub backlink. All examples sourced from real package API and demo scripts.
…s URL is stable The related-project cross-links pointed at Acoustic's canonical Pages URL, which 301-redirects while the repo is private. Name it as 'documentation coming soon' without the live link; the audio-classification deferral (this repo collects/owns its own modality, Acoustic owns audio analysis) is unchanged. Re-add the link on go-public.
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
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.
Summary
Content-depth SEO pass for the PyTorch-Wildlife docs site, claiming the cluster's framework / library / model zoo / training / inference keyword lane. Prose standardizes on "conservation deep learning framework". All API, model, and CLI-style details are sourced from the real package (
src/PytorchWildlife/**) anddemo/scripts; nothing was invented.Stacked on the infra branch: base is
seo/pw-infra-structured-data(infra PR #15). On merge of #15, this PR's base retargets tomain.Keyword lane
Priority:
pytorch wildlife,wildlife AI framework,conservation deep learning framework,wildlife model zoo,pytorchwildlife pip install. Boundary respected: the framework supports detection / audio / hardware but does not own them. Camera-trap detection links to MegaDetector, audio to MegaDetector-Acoustic, hardware to SPARROW; siblings are framed as the modality owners.Pages added
docs/api.md(API Overview): editorial tour of the load-and-run API with runnable detection, classification, detect-then-classify, video, and bioacoustics examples drawn from real method signatures (single_image_detection,batch_image_detection,single_image_classification,process_video,save_detection_*).docs/inference-examples.md(Inference Examples): single-image, batch-folder, video, and Gradio web-UI walkthroughs mapped to the actualdemo/scripts.Pages deepened
docs/index.md: leads with the value prop, "why a framework not just a model" section, standardized framework phrasing, em-dashes removed, ecosystem block reframed so siblings own their modalities.docs/model_zoo.md: H1 promoted to Wildlife Model Zoo; real model tables (MegaDetector V6 variants by license, V5, Deepfaune, HerdNet; classifiers with classes/geography/coverage); related-projects block.docs/installation.md: keyword-first title/description for "pytorchwildlife pip install"; tightened sections; next-steps cross-links.Internal linking
Each new page has 3+ inbound links, descriptive anchors, a hub backlink to microsoft.github.io/Biodiversity, and a "Related Microsoft biodiversity AI projects" block. Nav updated in
mkdocs.yml(API Overview, Inference Examples).Gates passed
mkdocs build --strict: clean (no link/nav errors; only benign git-timestamp notices for the two new files).grep -rn '—' docs/: clean (also fixed one pre-existing em-dash inbuild_mkdocs.md).[!TIP]callouts render as admonitions; internal links resolve.docs/**andmkdocs.yml. Nosrc/,pyproject.toml, demo code, or CI changed.site/not staged.Claims to verify (@zhmiao)
None. Every model name, class name, version string, license, method signature, and CLI/demo detail was read directly from
src/PytorchWildlife/**anddemo/. Two minor judgment calls worth a glance:console_scriptsinpyproject.toml), so no CLI page was created. Command-line usage is documented via the runnabledemo/scripts on the Inference Examples page instead.num_cls=36in the source, the others were not independently re-counted from weights.