Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #15

Merged
merged 1 commit into from
Aug 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Web: https://deepcausality.com

DeepCausality is a hyper-geometric computational causality library that enables fast and deterministic context-aware
causal reasoning over complex multi-stage causality models. Deep Causality adds only minimal overhead and thus is
suitable for real-time applications without additional acceleration hardware.[So, how is deep causality different from deep learning?](deep_causality/docs/difference.md)
suitable for real-time applications without additional acceleration hardware.

[How is deep causality different from deep learning?](deep_causality/docs/difference.md)

## 🤔 Why DeepCausality?

Expand All @@ -63,6 +65,32 @@ In your project folder, just run in a terminal:
cargo add deep_causality
```

## How to run the example code

```bash
git clone https://github.com/deepcausality-rs/deep_causality.git

cd deep_causality

make example
```

You can also run the example code from the project root with cargo:

```bash
# make sure you're in the project root folder
cd deep_causality

# CSM (Causal State Machine)
cargo run --release --bin example-csm

# CTX (Context)
cargo run --release --bin example-ctx

# Smoking inference
cargo run --release --bin example-smoking
```

## ⭐ Usage

See:
Expand Down
Loading