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

Fix README #74

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ jobs:
runs-on: ubuntu-latest
environment: testing
name: Unit Testing
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- name: Run cargo test
Expand All @@ -29,4 +30,4 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Run cargo fmt
run: cargo fmt --check
run: cargo fmt --check
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# neat
[<img alt="github" src="https://img.shields.io/github/last-commit/inflectrix/neat" height="20">](https://github.com/inflectrix/neat)
[<img alt="github" src="https://img.shields.io/github/last-commit/hypercodec/neat" height="20">](https://github.com/hypercodec/neat)
[<img alt="crates.io" src="https://img.shields.io/crates/d/neat" height="20">](https://crates.io/crates/neat)
[<img alt="docs.rs" src="https://img.shields.io/docsrs/neat" height="20">](https://docs.rs/neat)

Expand All @@ -12,6 +12,12 @@ Implementation of the NEAT algorithm using `genetic-rs`.

*Do you like this repo and want to support it? If so, leave a ⭐*

RAYON FEATURE WARNING: there is a known deadlock that can happen in rare scenarios.
This is an issue that requires an update to the `rayon` crate and no long-term fix can be made right now without unnecessary overhead.
It is recommended that you backup your generations with the `serde` feature when using `rayon` in case it deadlocks.
Because this pretty much happens randomly, you can simply start training again from the backup and it should work fine.
Sorry for the inconvenience.

### How To Use
When working with this crate, you'll want to use the `NeuralNetworkTopology` struct in your agent's DNA and
the use `NeuralNetwork::from` when you finally want to test its performance. The `genetic-rs` crate is also re-exported with the rest of this crate.
Expand Down