Skip to content

Commit 9680467

Browse files
committed
moved description to docstring
1 parent 8ed0d7a commit 9680467

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

docs/src/datasets/Mutagenesis.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
# Mutagenesis
22

3-
The `Mutagenesis` dataset comprises 188 molecules trialed for mutagenicity on Salmonella typhimurium, available from
4-
[relational.fit.cvut.cz](https://relational.fit.cvut.cz/dataset/Mutagenesis) and
5-
[CTUAvastLab/datasets](https://github.com/CTUAvastLab/datasets/tree/main/mutagenesis).
6-
7-
Train, test and validation data can be loaded using:
8-
```julia
9-
train_x, train_y = Mutagenesis.traindata()
10-
test_x, test_y = Mutagenesis.testdata()
11-
val_x, val_y = Mutagenesis.valdata()
12-
```
13-
143
```@docs
154
Mutagenesis
165
```

src/Mutagenesis/Mutagenesis.jl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
11
export Mutagenesis
2+
3+
"""
4+
Mutagenesis
5+
6+
Website: https://relational.fit.cvut.cz/dataset/Mutagenesis
7+
License: CC0
8+
9+
The `Mutagenesis` dataset comprises 188 molecules trialed for mutagenicity on Salmonella typhimurium, available from
10+
[relational.fit.cvut.cz](https://relational.fit.cvut.cz/dataset/Mutagenesis) and
11+
[CTUAvastLab/datasets](https://github.com/CTUAvastLab/datasets/tree/main/mutagenesis).
12+
13+
Train, test and validation data can be loaded using:
14+
```julia
15+
train_x, train_y = Mutagenesis.traindata()
16+
test_x, test_y = Mutagenesis.testdata()
17+
val_x, val_y = Mutagenesis.valdata()
18+
```
19+
"""
220
module Mutagenesis
321

422
using DataDeps, JSON3

0 commit comments

Comments
 (0)