hpi-epic / gpucsl

Constraint-based Causal Structure Learning on GPUs.
MIT License
38 stars 1 forks source link

Add documentation #2

Closed BraunTom closed 2 years ago

BraunTom commented 2 years ago

Adds docu for the most important functions and a guide on how to add your own CI test

github-actions[bot] commented 2 years ago

:white_check_mark: Result of Pytest Coverage

---------- coverage: platform linux, python 3.8.12-final-0 ----------- Name Stmts Miss Cover
gpucsl/init.py 0 0 100%
gpucsl/main.py 8 8 0%
gpucsl/cli/init.py 0 0 100%
gpucsl/cli/cli.py 73 18 75%
gpucsl/cli/cli_io.py 59 26 56%
gpucsl/cli/cli_util.py 9 1 89%
gpucsl/cli/command_line_parser.py 15 0 100%
gpucsl/pc/init.py 0 0 100%
gpucsl/pc/discover_skeleton_discrete.py 51 0 100%
gpucsl/pc/discover_skeleton_gaussian.py 52 0 100%
gpucsl/pc/edge_orientation/init.py 0 0 100%
gpucsl/pc/edge_orientation/edge_orientation.py 12 0 100%
gpucsl/pc/edge_orientation/orientation_rules.py 52 1 98%
gpucsl/pc/edge_orientation/v_structures.py 20 0 100%
gpucsl/pc/gaussian_device_manager.py 174 1 99%
gpucsl/pc/helpers.py 82 1 99%
gpucsl/pc/kernel_management.py 184 13 93%
gpucsl/pc/pc.py 25 2 92%
TOTAL 816 71 91%
================= 73 passed, 74