hughperkins / DeepCL

OpenCL library to train deep convolutional neural networks
Mozilla Public License 2.0
866 stars 200 forks source link

Documentation for C++ API #95

Closed akashsachdeva closed 8 years ago

akashsachdeva commented 8 years ago

Hi,

I have recently started working with CNN and also using this library(and its really good), so correct me if I am wrong somewhere.

In the documentation for C++ API mentioned here (https://github.com/hughperkins/DeepCL/blob/master/doc/NeuralNetAPI.md), I guess there are some changes in train and test part .

_NetLearner netLearner( trainer, net,Ntrain, trainData, trainLabels,Ntest, testData, testLabels ); netLearner.setSchedule( numEpochs );

netLearner.setBatchSize( batchSize );
netLearner.learn();_

The last two i.e. setBatchSize and learn argument is not available anymore.

Also for Test BatchLearner batchLearner( net ); int testNumRight = batchLearner.test( batchSize, Ntest, testData, testLabels );

I guess BatchLearner class is also not available anymore!!!

Can you please let me know the testing class... I am currently getting familiar with DeepCl (later to use in my uni project) and for that trying Lenet5. To test can you please suggest anything?

Thank You for your help!

hughperkins commented 8 years ago

The unit tests are pretty definitive; they all pass, ie take a look in https://github.com/hughperkins/deepcl/tree/master/test eg https://github.com/hughperkins/DeepCL/blob/master/test/testsimpleconvolvenet.cpp

Otherwise, there is doxygen documentation. I might need to regenerate it. The docs are at http://deepcl.hughperkins.com/4.x.x/html/annotated.html Seems like a really old version though. Perhaps I should regenerate it...

hughperkins commented 8 years ago

Updated the doxygen docs: http://deepcl.hughperkins.com/doxygen/annotated.html

hughperkins commented 8 years ago

(added notes on running doxy at https://github.com/hughperkins/DeepCL/blob/master/doc/doxy/Doxyfile )

Edit: I meant to write: https://github.com/hughperkins/DeepCL/blob/master/doc/doxy/README.md )

akashsachdeva commented 8 years ago

Thanks for the help..! I'll go through it.

hughperkins commented 8 years ago

k :-) Let me know if you have any questions/comments please.