Skip to content

Commit

Permalink
remove old benchmarks, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itsdfish committed Jul 18, 2024
1 parent 0ca9080 commit 0518d6a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 72 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,25 @@
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://itsdfish.github.io/ACTRModels.jl/dev/)

The goal of ACTRModels.jl is to provide basic types and functions for developing models based on the [ACT-R](https://en.wikipedia.org/wiki/ACT-R) cognitive architecture. Please see the documentation for installation instructions, working examples, and related pacakges.


# Simple Example

```julia
using ACTRModels

# create chunks of declarative knowledge
chunks = [Chunk(; name = :Bob, department = :accounting),
Chunk(; name = :Alice, department = :HR)]
# initialize declarative memory
declarative = Declarative(memory = chunks)

# specify model parameters: partial matching, noise, mismatch penalty, activation noise
Θ = (mmp = true, noise = true, δ = 1.0, s = 0.20)

# create an ACT-R object with activation noise and partial matching
actr = ACTR(; declarative, Θ...)

# retrieve a chunk
chunk = retrieve(actr; department = :accounting)
```
72 changes: 0 additions & 72 deletions test/benchmarks.jl

This file was deleted.

0 comments on commit 0518d6a

Please sign in to comment.