Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardt committed Apr 6, 2016
1 parent dc3f965 commit c967e51
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

{docs}
Net
Ensemble
Connection
Param
TaskSet
JuliaTask
Expand Down
27 changes: 27 additions & 0 deletions src/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,20 @@ Returns the batch size of the network
"""
batch_size(net::Net) = net.batch_size

"""
A connection between two ensembles.
** Fields **
- source -- the source `Ensemble`
- mapping -- a mapping function to a range of neurons in `source`
- shape -- shape of the connected neurons returned by `mapping`
- size -- length of the connected neurons returned by `mapping`
- copy -- whether the connection requires input values to be copied
- is_dim_fixed -- vector of booleans that are true if the connection is fixed along a dimension
- is_one_to_one -- whether the connection is one to one
- padding -- amount of padding used for the connection
- recurrent -- whether the connection is recurrent
"""
type Connection
source :: AbstractEnsemble
mapping :: Function
Expand All @@ -234,6 +248,19 @@ type Connection
recurrent :: Bool
end

"""
An ensemble
** Fields **
- name -- name of the ensemble
- neurons -- an array of neurons of type `T`
- connections -- a list of `Ensemble`s connected to this ensemble
- batch_fields -- a vector of `Batch` fields for `T` (used internally)
- arg_dim_info --
- params -- a vector of `Param`s associated with the ensemble
- phase -- phase(s) in which this ensemble is active
- net_subgroup -- the net subgroup the ensemble is a member of (use for model parallelism)
"""
type Ensemble{T <: Neuron, N} <: AbstractEnsemble
name :: Symbol
neurons :: Array{T,N}
Expand Down

0 comments on commit c967e51

Please sign in to comment.