aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api/dataset.md
blob: fbb89baf6730c0ee735187dc6793a9dce4bfc47e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Dataset package

```{eval-rst}
.. automodule:: sec_certs.dataset
    :no-members:
```

This documentation doesn't provide full API reference for all members of `dataset` package. Instead, it concentrates on the Dataset that are immediately exposed to the users.
Namely, we focus on `CCDataset`, `FIPSDataset`, `ProtectionProfileDataset` and their abstract base class `Dataset`.

```{tip}
The examples related to this package can be found in the [common criteria notebook](./../notebooks/examples/cc.ipynb),
the [protection profile notebook](./../notebooks/examples/protection_profiles.ipynb), and the [fips notebook](./../notebooks/examples/fips.ipynb).
```

## Base Dataset

```{eval-rst}
.. currentmodule:: sec_certs.dataset.dataset
.. autoclass:: Dataset
    :members:
```

## CCDataset

```{eval-rst}
.. currentmodule:: sec_certs.dataset
.. autoclass:: CCDataset
    :members:
```

## ProtectionProfileDataset

```{eval-rst}
.. currentmodule:: sec_certs.dataset
.. autoclass:: ProtectionProfileDataset
    :members:
```

## FIPSDataset

```{eval-rst}
.. currentmodule:: sec_certs.dataset
.. autoclass:: FIPSDataset
    :members:
```