A new, blazing-fast learning engine for Continuous Time Bayesian Networks. Written in pure Rust. 🦀
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
reCTBN/README.md

66 lines
947 B

<div align="center">
# reCTBN
</div>
## Library
> **Note:** At the moment it's in pre-alpha state.
A Continuous Time Bayesian Networks Library written in Rust. 🦀
## Develop
**Prerequisites:**
+ `rust`
_Prepare_ the development environment:
```sh
cargo build
```
That's all! ☕
## Contribute
See [CONTRIBUTING.md](CONTRIBUTING.md) to know how to report bugs, propose
features, merge requests or other forms of contribution! 😎🚀
## Testing & Linting
To launch **tests**:
```sh
cargo test
```
To **lint** with `cargo check`:
```sh
cargo check --all-targets
```
Or with `clippy`:
```sh
cargo clippy --all-targets -- -A clippy::all -W clippy::correctness
```
To check the **formatting**:
> **NOTE:** remove `--check` to apply the changes to the file(s).
```sh
cargo fmt --all -- --check
```
## Documentation
To generate the **documentation**:
```sh
cargo rustdoc --package reCTBN --open -- --default-theme=ayu
```