Skip to content

Lack of documentation/tutorials #23

Description

@SirSkaro

First of all, thank you for implementing CLARION in Python.

I'm starting a research project using pyClarion to play a video game. I've noticed that from version 0.17 to 0.18 that the top-level directory with examples was renamed to tutorial, but that the breadth of the examples was significantly reduced. notes.md walks through some very high-level and simple usage but assumes the usage of a ccml file and no NACS or MCS. I've been wrestling with pyClarion for a few days trying to figure out how to programmatically create a Store with one chunk composed of a couple features, but I haven't been able to figure out how (or even verify if I have succeeded). I realize that the library is experimental and based off Anatomy of the Mind, but I feel having more resources (outside of a $160, 480 page book) would be an essential part of promoting adoption of pyClarion.

In particular, would it be possible to add more documentation or examples for some of the following please?

  • The CCML spec (with some examples)
  • How to populate an initial chunk database
  • How to populate an initial rule database
  • A free-association example (the Alice example)
  • A working memory example
  • A migration guide to go from 0.17 to 0.18 (so that old examples can be ported to the new modules and classes)
  • An acronym guide - looking through the source code, I'm seeing lots of acronyms and abbreviations, which make the code very difficult to understand for someone not intimately familiar with the domain.
  • More explanation of using TopDown and BottomUp

I'm not sure how relevant each of the above is to v0.18 anymore. I'd prefer to not use v0.17.1, but there seem to be way more resources for using it.

I also think that one of the most effective forms of documentation is automated tests. This could be an effective way to both document and validate/verify code changes without having to manually update written guides. For example, a test for a free association problem or setting up a Store from a CCML file.

Thank you.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions