docs: add auto-generated code documentation#117
Draft
enesgules wants to merge 1 commit intoCAIIVS:mainfrom
Draft
docs: add auto-generated code documentation#117enesgules wants to merge 1 commit intoCAIIVS:mainfrom
enesgules wants to merge 1 commit intoCAIIVS:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new docs/codedocs/ documentation set (auto-generated by Context7) describing RAITAP’s architecture, core concepts, artifact lifecycle, and public API/type surface.
Changes:
- Introduces concept/architecture pages (model+data, explainers+semantics, outputs/tracking/reporting, Hydra config, overall architecture).
- Adds API reference pages for major modules (run, configs, data, models, metrics, transparency, tracking, reporting, utils).
- Adds practical guides for CLI runs, custom data/labels, SHAP background/batching, and enabling tracking+reports.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/codedocs/index.md | Getting-started entry point and navigation to the rest of codedocs. |
| docs/codedocs/architecture.md | High-level system architecture and data flow diagrams. |
| docs/codedocs/hydra-configuration.md | Explains Hydra schema/groups and override patterns. |
| docs/codedocs/model-and-data.md | Describes model backend resolution and data/label loading. |
| docs/codedocs/explainers-and-semantics.md | Documents explainer factory, semantics, and compatibility concepts. |
| docs/codedocs/outputs-tracking-and-reporting.md | Explains artifact lifecycle across metrics/transparency/reporting/tracking. |
| docs/codedocs/types.md | Collects key public dataclasses/enums/protocols used across the library. |
| docs/codedocs/guides/cli-assessment.md | Step-by-step CLI smoke-test guide. |
| docs/codedocs/guides/custom-data-and-labels.md | Guide for loading custom datasets and aligning labels. |
| docs/codedocs/guides/shap-background-and-batching.md | Guide for SHAP background sources and batching controls. |
| docs/codedocs/guides/tracking-and-reports.md | Guide for enabling MLflow tracking and PDF reports. |
| docs/codedocs/api-reference/configs.md | API reference for config schema/utilities. |
| docs/codedocs/api-reference/data.md | API reference for Data and source-based loaders/metadata inference. |
| docs/codedocs/api-reference/models.md | API reference for model loading and backend abstraction. |
| docs/codedocs/api-reference/metrics.md | API reference for metrics computers and orchestration helpers. |
| docs/codedocs/api-reference/reporting.md | API reference for report builders/reporters and report structures. |
| docs/codedocs/api-reference/run.md | API reference for run, CLI entrypoints, and output dataclasses. |
| docs/codedocs/api-reference/tracking.md | API reference for tracker interface and MLflow tracker. |
| docs/codedocs/api-reference/transparency-core.md | API reference for transparency factories/contracts/results/helpers. |
| docs/codedocs/api-reference/transparency-visualisers.md | API reference for built-in visualiser classes and usage patterns. |
| docs/codedocs/api-reference/utils.md | API reference for to_json_serialisable. |
|
|
||
| <Callout type="info">RAITAP is published as a Python package, not an npm package. The tabs below are included to match the documentation shell used by this site; every tab installs the same Python dependency set.</Callout> | ||
|
|
||
| " "bun"]}> |
| from raitap.transparency import CaptumImageVisualiser | ||
|
|
||
| visualiser = CaptumImageVisualiser(show_colorbar=False) | ||
| fig = visualiser.visualise(attributions inputs=inputs) |
Comment on lines
+138
to
+147
| @dataclass(frozen=True init=False) | ||
| class InputSpec: | ||
| kind: InputKind | None | ||
| shape: tuple[int, ...] | None | ||
| layout: TensorLayout | None | ||
| feature_names: list[str] | None = None | ||
| metadata: Mapping[str, Any] | None = None | ||
|
|
||
| @dataclass(frozen=True init=False) | ||
| class OutputSpaceSpec: |
| from raitap.run import run | ||
|
|
||
| with initialize_config_dir(version_base="1.3", config_dir=str(Path("src/raitap/configs").resolve())): | ||
| cfg = compose(config_name="config" overrides=["hardware=cpu", "reporting=disabled"]) |
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.
Auto-generated Code Documentation
AI-analyzed source code to produce structured documentation including:
Browse the documentation →
Generated by Context7 · View docs