Skip to content

Commit 0841a6c

Browse files
committed
Add note linking to Julia-XAI "Getting started" guide
1 parent 0fb4bd3 commit 0841a6c

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Contributions are welcome!
160160
[docs-stab-img]: https://img.shields.io/badge/docs-stable-blue.svg
161161
[docs-stab-url]: https://julia-xai.github.io/XAIDocs/ExplainableAI/stable/
162162

163-
[docs-dev-img]: https://img.shields.io/badge/docs-main-blue.svg
163+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
164164
[docs-dev-url]: https://julia-xai.github.io/ExplainableAI.jl/dev
165165

166166
[ci-img]: https://github.com/Julia-XAI/ExplainableAI.jl/workflows/CI/badge.svg

docs/src/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ CurrentModule = ExplainableAI
44

55
# ExplainableAI.jl
66

7-
Explainable AI in Julia.
7+
Explainable AI methods in Julia.
8+
9+
!!! note
10+
This package is part of a wider [Julia XAI ecosystem](https://github.com/Julia-XAI).
11+
For an introduction to this ecosystem, please refer to the
12+
[Getting started guide](https://julia-xai.github.io/XAIDocs/).
813

914
## Installation
1015
To install this package and its dependencies, open the Julia REPL and run
@@ -13,7 +18,6 @@ julia> ]add ExplainableAI
1318
```
1419

1520
## Manual
16-
### General usage
1721
```@contents
1822
Pages = [
1923
"generated/example.md",

docs/src/literate/example.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# # [Getting started](@id docs-getting-started)
2+
3+
#md # !!! note
4+
#md # This package is part of a wider [Julia XAI ecosystem](https://github.com/Julia-XAI).
5+
#md # For an introduction to this ecosystem, please refer to the
6+
#md # [Getting started guide](https://julia-xai.github.io/XAIDocs/).
7+
28
# For this first example, we already have loaded a pre-trained LeNet5 model
39
# to look at explanations on the MNIST dataset.
410
using ExplainableAI

0 commit comments

Comments
 (0)