BayesNet/README.md

103 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2024-04-21 09:31:27 +00:00
# <img src="logo.png" alt="logo" width="50"/> BayesNet
2023-06-29 19:52:57 +00:00
![C++](https://img.shields.io/badge/c++-%2300599C.svg?style=flat&logo=c%2B%2B&logoColor=white)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](<https://opensource.org/licenses/MIT>)
2024-03-11 09:57:27 +00:00
![Gitea Release](https://img.shields.io/gitea/v/release/rmontanana/bayesnet?gitea_url=https://gitea.rmontanana.es:3000)
2024-04-07 00:08:37 +00:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cf3e0ac71d764650b1bf4d8d00d303b1)](https://app.codacy.com/gh/Doctorado-ML/BayesNet/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=rmontanana_BayesNet&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=rmontanana_BayesNet)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=rmontanana_BayesNet&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=rmontanana_BayesNet)
2024-04-07 10:35:21 +00:00
![Gitea Last Commit](https://img.shields.io/gitea/last-commit/rmontanana/bayesnet?gitea_url=https://gitea.rmontanana.es:3000&logo=gitea)
2024-06-21 11:58:42 +00:00
[![Coverage Badge](https://img.shields.io/badge/Coverage-97,1%25-green)](html/index.html)
2024-01-07 18:58:22 +00:00
Bayesian Network Classifiers using libtorch from scratch
2023-09-18 21:26:22 +00:00
2024-04-08 20:41:23 +00:00
## Dependencies
The only external dependency is [libtorch](https://pytorch.org/cppdocs/installing.html) which can be installed with the following commands:
```bash
wget https://download.pytorch.org/libtorch/nightly/cpu/libtorch-shared-with-deps-latest.zip
unzip libtorch-shared-with-deps-latest.zips
```
## Setup
2024-03-08 08:02:22 +00:00
2024-04-21 16:54:13 +00:00
### Getting the code
```bash
git clone --recurse-submodules https://github.com/doctorado-ml/bayesnet
```
2023-09-18 21:26:22 +00:00
### Release
```bash
make release
2024-01-07 18:58:22 +00:00
make buildr
2024-03-08 08:02:22 +00:00
sudo make install
2023-09-18 21:26:22 +00:00
```
### Debug & Tests
```bash
make debug
2024-01-07 18:58:22 +00:00
make test
2024-04-21 16:54:13 +00:00
```
### Coverage
```bash
2024-01-07 18:58:22 +00:00
make coverage
2024-04-21 16:54:13 +00:00
make viewcoverage
```
2024-02-27 16:16:26 +00:00
### Sample app
2024-03-08 08:02:22 +00:00
After building and installing the release version, you can run the sample app with the following commands:
2024-02-27 16:16:26 +00:00
```bash
make sample
make sample fname=tests/data/glass.arff
```
## Models
2024-04-30 16:59:38 +00:00
#### - TAN
#### - KDB
#### - SPODE
2024-05-22 09:39:33 +00:00
#### - SPnDE
2024-04-30 16:59:38 +00:00
#### - AODE
#### - [BoostAODE](docs/BoostAODE.md)
2024-05-22 09:39:33 +00:00
#### - BoostA2DE
2024-04-30 16:59:38 +00:00
### With Local Discretization
#### - TANLd
#### - KDBLd
#### - SPODELd
#### - AODELd
2024-04-19 12:33:00 +00:00
2024-05-22 09:39:33 +00:00
## Documentation
### [Manual](https://rmontanana.github.io/bayesnet/)
### [Coverage report](https://rmontanana.github.io/bayesnet/coverage/index.html)
2024-05-22 09:39:33 +00:00
2024-04-19 12:33:00 +00:00
## Diagrams
### UML Class Diagram
![BayesNet UML Class Diagram](diagrams/BayesNet.svg)
### Dependency Diagram
![BayesNet Dependency Diagram](diagrams/dependency.svg)