Skip to content

Commit

Permalink
cannot include backticks from markdown in go doc comments!
Browse files Browse the repository at this point in the history
  • Loading branch information
Randall C. O'Reilly committed May 7, 2019
1 parent 7ca28da commit 44e856d
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,34 @@ into the following sub-repositories:
Network, Layer, and Prjn (projection). These contain no algorithm-specific code
and are only about the overall structure of a network, sufficient to support general
purpose tools such as the 3D NetView. It also houses widely-used support classes used
in algorithm-specific code, including things like `MinMax` and `AvgMax`, and also the
parameter-styling infrastructure (`emer.Params`, `emer.ParamStyle`, `emer.ParamSet` and
`emer.ParamSets`).
in algorithm-specific code, including things like MinMax and AvgMax, and also the
parameter-styling infrastructure (emer.Params, emer.ParamStyle, emer.ParamSet and
emer.ParamSets).
* `erand` has misc random-number generation support functionality, including
erand.RndParams` for parameterizing the type of random noise to add to a model,
* erand has misc random-number generation support functionality, including
erand.RndParams for parameterizing the type of random noise to add to a model,
and easier support for making permuted random lists, etc.
* `netview` provides the `NetView` interactive 3D network viewer, implemented in the GoGi 3D framework.
* netview provides the NetView interactive 3D network viewer, implemented in the GoGi 3D framework.
* `prjn` is a separate package for defining patterns of connectivity between layers
(i.e., the `ProjectionSpec`s from C++ emergent). This is done using a fully independent
* prjn is a separate package for defining patterns of connectivity between layers
(i.e., the ProjectionSpecs from C++ emergent). This is done using a fully independent
structure that *only* knows about the shapes of the two layers, and it returns a fully general
bitmap representation of the pattern of connectivity between them. The `leabra.Prjn` code
bitmap representation of the pattern of connectivity between them. The leabra.Prjn code
then uses these patterns to do all the nitty-gritty of connecting up neurons.
This makes the projection code *much* simpler compared to the ProjectionSpec in C++ emergent,
which was involved in both creating the pattern and also all the complexity of setting up the
actual connections themselves. This should be the *last* time any of those projection patterns
need to be written (having re-written this code too many times in the C++ version as the details
of memory allocations changed).
* `patgen` supports various pattern-generation algorithms, as implemented in `taDataGen`
in C++ emergent (e.g., `PermutedBinary` and `FlipBits`).
* patgen supports various pattern-generation algorithms, as implemented in taDataGen
in C++ emergent (e.g., PermutedBinary and FlipBits).
* `timer` is a simple interval timing struct, used for benchmarking / profiling etc.
* timer is a simple interval timing struct, used for benchmarking / profiling etc.
* `python` contains a template `Makefile` that uses [GoPy](https://github.com/goki/gopy) to generate
python bindings to the entire emergent system. See the `leabra` package version to actually run an example.
* python contains a template Makefile that uses [GoPy](https://github.com/goki/gopy) to generate
python bindings to the entire emergent system. See the leabra package version to actually run an example.
*/
package emergent

0 comments on commit 44e856d

Please sign in to comment.