Skip to content

Commit 182755b

Browse files
committed
Merge branch 'main' into release
2 parents 634b5f7 + 2530ce5 commit 182755b

File tree

104 files changed

+1657
-1699
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+1657
-1699
lines changed

.github/workflows/continuous_integration.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,4 @@ jobs:
144144
#----------------------------------------------
145145
- name: Test with pytest
146146
run: |
147-
poetry run python -m pytest -vv --cov=ethicml --cov-fail-under=80 tests/
147+
poetry run python -m pytest -vv -n 2 --dist loadgroup --cov=ethicml --cov-fail-under=80 tests/

docs/algorithms/index.rst

-16
This file was deleted.

docs/algorithms/inprocess.rst

-70
This file was deleted.

docs/algorithms/postprocess.rst

-20
This file was deleted.

docs/algorithms/preprocess.rst

-34
This file was deleted.

docs/data/index.rst

-16
This file was deleted.

docs/data/tabular_data.rst

-52
This file was deleted.

docs/data/util.rst

-17
This file was deleted.

docs/ethicml.data.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
************
2+
ethicml.data
3+
************
4+
5+
.. automodule:: ethicml.data
6+
:members:
7+
:imported-members:
8+
:autosummary:
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
*******
2-
Metrics
3-
*******
1+
***************
2+
ethicml.metrics
3+
***************
44

55
.. automodule:: ethicml.metrics
66
:members:
77
:imported-members:
88
:autosummary:
9-
10-
Utils
11-
=====
12-
13-
.. toctree::
14-
:glob:
15-
16-
./*
File renamed without changes.
File renamed without changes.

docs/ethicml/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*******
2+
ethicml
3+
*******
4+
5+
.. automodule:: ethicml
6+
:no-members:
7+
:no-imported-members:
8+
9+
.. toctree::
10+
:glob:
11+
12+
./*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/evaluators/index.rst

-12
This file was deleted.

docs/index.rst

+12-12
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,16 @@ Example
1111
.. code:: python
1212
1313
import ethicml as em
14+
import ethicml.data as emda
15+
import ethicml.models as emmo
16+
from ethicml import metrics
1417
1518
results = em.evaluate_models(
16-
datasets=[em.Adult()],
17-
inprocess_models=[em.SVM(), em.Kamiran()],
18-
preprocess_models=[em.Upsampler()],
19-
metrics=[em.Accuracy()],
20-
per_sens_metrics=[em.ProbPos(), em.TPR()],
19+
datasets=[emda.Adult()],
20+
inprocess_models=[emmo.SVM(), emmo.Kamiran()],
21+
preprocess_models=[emmo.Upsampler()],
22+
metrics=[metrics.Accuracy()],
23+
per_sens_metrics=[metrics.ProbPos(), metrics.TPR()],
2124
repeats=5,
2225
)
2326
em.plot_results(results, "Accuracy", "prob_pos_Male_0/Male_1")
@@ -29,13 +32,10 @@ API
2932
.. toctree::
3033
:maxdepth: 2
3134

32-
algorithms/index
33-
data/index
34-
evaluators/index
35-
metrics/index
36-
preprocessing
37-
utility
38-
visualisation
35+
ethicml/index
36+
ethicml.data
37+
models/index
38+
ethicml.metrics
3939

4040

4141

docs/metrics/per_sensitive_attribute.rst

-5
This file was deleted.

docs/models/index.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
**************
2+
ethicml.models
3+
**************
4+
5+
.. automodule:: ethicml.models
6+
7+
.. toctree::
8+
:glob:
9+
10+
./*
11+
12+
13+
Algorithms base
14+
===============
15+
16+
.. automodule:: ethicml.models.algorithm_base

0 commit comments

Comments
 (0)