Skip to content

Commit

Permalink
Documentation Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Clemens Marschner committed May 18, 2016
1 parent 402fee1 commit 83c152f
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions Source/Common/Include/Eval.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
namespace Microsoft { namespace MSR { namespace CNTK {

template <typename ElemType>
class IEvaluateModelBase // Evaluate Model Interface
class IEvaluateModelBase
{
public:
//
Expand All @@ -39,16 +39,16 @@ class IEvaluateModelBase // Evaluate Model Interface
//
virtual void Init(const std::string& config) = 0;

//
// Create a network based on an (NDL) network description.
//
virtual void CreateNetwork(const std::string& networkDescription) = 0;

//
// Free resources
//
virtual void Destroy() = 0;

//
//
//
virtual void ResetState() = 0;
};

Expand Down Expand Up @@ -86,13 +86,15 @@ class IEvaluateModel : public IEvaluateModelBase<ElemType> // Evaluate Model Int
// Given a feature vector of dimension d, the inputs may contain n * d elements. The output will then be computed
// for n samples.
// inputs - map from node name to array of input tensors, flattened to vector
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will happen during evaluation
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will
// happen during evaluation
//
virtual void Evaluate(std::map<std::wstring, std::vector<ElemType>*>& inputs, std::map<std::wstring, std::vector<ElemType>*>& outputs) = 0;

//
// Evaluate - Evaluate using the network without input and provide the outputs
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will happen during evaluation
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will
// happen during evaluation
//
virtual void Evaluate(std::map<std::wstring, std::vector<ElemType>*>& outputs) = 0;
};
Expand Down Expand Up @@ -129,6 +131,7 @@ class Eval : public IEvaluateModel<ElemType>, protected Plugin
// modelPath=c:\models\model.dnn (model path, if not specified, must call LoadModel() method before Evaluate()
// minibatchSize=1024 (minibatch size used during evaluation if < passed data size)
Eval(const std::string& config);

virtual ~Eval();

// CreateNetwork - create a network based on the network description
Expand All @@ -146,14 +149,17 @@ class Eval : public IEvaluateModel<ElemType>, protected Plugin

// Evaluate - Evaluate using the model with the given inputs and outputs
// inputs - map from node name to input vector
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will happen during evaluation
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will
// happen during evaluation
virtual void Evaluate(std::map<std::wstring, std::vector<ElemType>*>& inputs, std::map<std::wstring, std::vector<ElemType>*>& outputs);

// Evaluate - Evaluate using the network without input, and provide the outputs
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will happen during evaluation
// outputs - map from node name to output vector, outputs vectors need to be preallocated by caller, sizing will
// happen during evaluation
virtual void Evaluate(std::map<std::wstring, std::vector<ElemType>*>& outputs);

virtual void Init(const std::string& config);

virtual void ResetState();
};

Expand Down

0 comments on commit 83c152f

Please sign in to comment.