Skip to content

Commit 9d1e210

Browse files
committed
Corrections and updates to README
1 parent 47543e9 commit 9d1e210

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ The current release is **BrainBlocks 0.7.0**.
66

77
## Introduction
88

9-
BrainBlocks is a framework developed by [The Aerospace Corporation](http://aerospace.org) for building scalable Machine Learning (ML) applications using principles derived from theories about the brain. It leverages the properties of binary representations, vectors of 1s and 0s, to form a "cortial language" where hierarchies of blocks can share information with one another using a universal communication standard. The design of BrainBlocks represents the practical experience gained from solving machine learning problems using a [Hierarchical Temporal Memory](https://numenta.com/assets/pdf/biological-and-machine-intelligence/BAMI-Complete.pdf) (HTM) -like approach. Please see our [extended documentation](docs/extended_readme.md) for more detailed information on BrainBlocks.
9+
BrainBlocks is a framework developed by [The Aerospace Corporation](http://aerospace.org) for building scalable Machine Learning (ML) applications using principles derived from theories about the brain. It leverages the properties of binary representations, vectors of 1s and 0s, to form a "cortial language" where hierarchies of blocks can share information with one another using a universal communication standard. The design of BrainBlocks represents the practical experience gained from solving machine learning problems using a [Hierarchical Temporal Memory](https://numenta.com/assets/pdf/biological-and-machine-intelligence/BAMI-Complete.pdf) (HTM) like approach.
1010

11-
BrainBlocks is a Python 3 library wrapped around a C++ backend. Currently it only operates on a single CPU thread, but plans are in the works for multi-threaded, GPU-accelerated, and FPGA-accelerated algorithms.
11+
BrainBlocks is a Python 3 library wrapped around a single-thread C++ backend. Earlier versions were GPU or FPGA accelerated, and we plan to return parallelization to BrainBlocks.
1212

1313
BrainBlocks is designed to be:
1414

@@ -19,6 +19,8 @@ BrainBlocks is designed to be:
1919
- **Low Memory**: maintain as low memory footprint as possible
2020
- **Lightweight**: small project size
2121

22+
Read our [extended documentation](docs/extended_readme.md) for further information about the what and why of BrainBlocks.
23+
2224
## Example Usage
2325

2426
Here is a simple example Python script of an anomaly detection BrainBlocks architecture that operates similar to HTM. Other scripts may be found in the `examples/` directory.
@@ -51,7 +53,7 @@ sl = SequenceLearner(
5153
perm_dec=1) # receptor permanence decrement
5254

5355
# Connect blocks
54-
sl.input.add_child(st.output, t=0) # 0 = observe current output bits
56+
sl.input.add_child(st.output) # connect sequence_learner input to scalar_transformer output
5557

5658
# Loop through data
5759
for value in values:
@@ -100,7 +102,7 @@ Build and install python package from project directory:
100102
$ python installer.py --install
101103
```
102104

103-
Test Python installation (RECCOMENDED):
105+
Test Python installation (RECOMMENDED):
104106

105107
```bash
106108
$ pytest test/
@@ -125,18 +127,18 @@ $ python installer.py --uninstall
125127

126128
## Running Examples
127129

128-
Run data classification example:
130+
Run anomaly detection example:
129131

130132
```bash
131-
$ python examples/python/applications/sklearn_style_classifier.py
133+
$ python examples/python/anomaly_detection/multivariate_anomaly_detection.py
132134
```
133135

134136
![Multivariate Abnormalities](docs/assets/multivariate_abnormalities.png)
135137

136-
Run anomaly detection example:
138+
Run data classification example:
137139

138140
```bash
139-
$ python examples/python/applications/multivariate_anomaly_detection.py
141+
$ python examples/python/experiments/BBClassifier/run_classifier_comparison.py
140142
```
141143

142144
![Data Classification](docs/assets/classifier_comparison.png)
@@ -186,4 +188,4 @@ This projected was developed internally at [The Aerospace Corporation](http://ae
186188

187189
This project is licensed under [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html).
188190

189-
© The Aerospace Corporation 2020
191+
© The Aerospace Corporation 2021

0 commit comments

Comments
 (0)