docs: overhaul module guides and remove temporary markdownlintignore#82
Open
asim29 wants to merge 1 commit intopr/5-examplesfrom
Open
docs: overhaul module guides and remove temporary markdownlintignore#82asim29 wants to merge 1 commit intopr/5-examplesfrom
asim29 wants to merge 1 commit intopr/5-examplesfrom
Conversation
All nine module-guide docs updated to reflect the new attack/defense API (poison_train/poison_test split, prepare_model_populations lifecycle, load_or_train pattern, AmuletDataset schema). CONTRIBUTING.md and GETTING_STARTED.md refreshed accordingly. Removes .markdownlintignore, which was added in PR 1 as a scoping workaround; docs now pass markdownlint cleanly.
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.
Context
Final PR in the
refactor/risk-modulesstack. Stacked on #81 (examples). Purely documentation — no source code changes.Changes
docs/module_guide/(all nine guides updated)poison_train/poison_testsplit,prepare_model_populationslifecycle for distribution inference,load_or_trainpattern in examples.AmuletDatasetschema (modality,sensitive_columns) documented.docs/CONTRIBUTING.mddocs/GETTING_STARTED.mdget_started.pyscript..markdownlintignore(deleted)markdownlintcleanly, so the ignore file is removed.Test plan
uv run pre-commit run --all-files(markdownlint passes without the ignore file)