diff options
| author | Determinant <ted.sybil@gmail.com> | 2016-04-28 12:54:26 +0800 |
|---|---|---|
| committer | Determinant <ted.sybil@gmail.com> | 2016-04-28 12:54:26 +0800 |
| commit | 53d59b9fff59d657c024673a9a0b54b396feb8d6 (patch) | |
| tree | d0bbd6e296fdfe03fb0f0f270719360c202cd783 /nerv/io | |
| parent | e4c6f4a6b7c537969fdea4abcebdfda884fa3bbc (diff) | |
add doc
Diffstat (limited to 'nerv/io')
| -rw-r--r-- | nerv/io/frm_buffer.lua | 4 | ||||
| -rw-r--r-- | nerv/io/init.lua | 4 | ||||
| -rw-r--r-- | nerv/io/seq_buffer.lua | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/nerv/io/frm_buffer.lua b/nerv/io/frm_buffer.lua index 45f73a0..06bea0b 100644 --- a/nerv/io/frm_buffer.lua +++ b/nerv/io/frm_buffer.lua @@ -3,7 +3,7 @@ -- @author Ted Yin <ted.sybil@gmail.com> --- The class for a frame-level chopped and shuffled buffer --- which shall be used for acyclic feed forward NNs +-- which shall be used for acyclic feed forward NNs. -- @type nerv.FrmBuffer local FrmBuffer = nerv.class("nerv.FrmBuffer", "nerv.DataBuffer") @@ -150,7 +150,7 @@ function FrmBuffer:saturate() end --- Get a batch group from the buffer. --- See `nerv.DataBuffer` for reference +-- See `nerv.DataBuffer` for reference. function FrmBuffer:get_data() local batch_size = self.batch_size diff --git a/nerv/io/init.lua b/nerv/io/init.lua index 4ebbabf..f0a3d52 100644 --- a/nerv/io/init.lua +++ b/nerv/io/init.lua @@ -11,7 +11,7 @@ -- * `write(handle)`: define how to write to a file handle -- * `get_info()`: return a table of chunk metadata -- * `set_info(info)`: set the metadata of the chunk --- * for more information, please refer to `nerv.MatrixParam` as an example +-- * for more information, please refer to `nerv.MatrixParam` as an example. -- @type nerv.ChunkFile function nerv.ChunkFile:write_chunkdata(metadata, writer) @@ -80,7 +80,7 @@ function DataReader:__init(global_conf, reader_conf) nerv.error_method_not_implemented() end ---- Get a data block from the reader +--- Get a data block from the reader. -- @return a table which maps data slot identifiers to data matrices. A data -- slot identifier is a unique string naming one slot of data. Each identifier -- maps to a matrix containing the data. (`{<slot_id> = <data matrix>, ...}`) It diff --git a/nerv/io/seq_buffer.lua b/nerv/io/seq_buffer.lua index 65df617..8cde1b3 100644 --- a/nerv/io/seq_buffer.lua +++ b/nerv/io/seq_buffer.lua @@ -116,7 +116,7 @@ function SeqBuffer:saturate(batch) end --- Get a batch group from the buffer. --- See `nerv.DataBuffer` for reference +-- See `nerv.DataBuffer` for reference. function SeqBuffer:get_data() local has_data = false |