diff options
| author | Ted Yin <[email protected]> | 2015-06-05 11:03:14 +0800 |
|---|---|---|
| committer | Ted Yin <[email protected]> | 2015-06-05 11:03:14 +0800 |
| commit | 3bdb17da736a8fa15786c6d42aa19233c07e3f8a (patch) | |
| tree | 27a0586e148ce53c2828effa2d9977e1619ad3dd /doc/nerv_param.md | |
| parent | df737041e4a9f3f55978cc74db9a9cea27fa9fa0 (diff) | |
| parent | 92cc3cffec87dbebd1e79b51ead2d04b52fbd0d4 (diff) | |
Merge pull request #17 from cloudygoose/master
change doc
Diffstat (limited to 'doc/nerv_param.md')
| -rw-r--r-- | doc/nerv_param.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/nerv_param.md b/doc/nerv_param.md new file mode 100644 index 0000000..87ea1af --- /dev/null +++ b/doc/nerv_param.md @@ -0,0 +1,26 @@ +#The Nerv Parameter Package# +Part of the [Nerv](../README.md) toolkit. + +##Description## +###Class hierarchy### +There is a base class __Nerv.Param__ defined in `layer/init.lua`. +__Nerv.MatrixParam__ inherits __Nerv.Param__. +__Nerv.LinearTransParam__, __Nerv.BiasParam__ inherits __Nerv.MatrixParam__. +###Class member### +* __Nerv.MatrixParam__ + * __nerv.CuMatrix__ trans + Stores the parameter matrix. + +##Methods## +* __void Param.\_\_init(Param self, string id, table global_conf)__ +Constructor of a __Param__, it will set `self.id` to be `id` and `self.gconf` to be `global_conf`. +* __void Param.set_info(table info)__ +Set `self.info` to be `info`. +* __table Param.get_info()__ +Returns `self.info`. +* __void Param.read(ChunkData pcdata)__ +This is not implemented in `nerv.Param`. +* __void MatrixParam.read(MatrixParam self, ChunkData pcdata)__ +Read `self.trans` from `pcdata`. +* __void MatrixParam.write(MatrixParam self, ChunkFileHandle pfhandle)__ +Write `self.trans` to `pfhandle`.
\ No newline at end of file |