OnlineEngine Class Reference

Engine for performing inference and learning online. More...

#include <onlineengine.h>

List of all members.

Public Member Functions
	OnlineEngine (const string &inferString)
	Constructs an OnlineEngine from a string of inference options.
	OnlineEngine (Inference *inference)
	Constructs an OnlineEngine from an Inference object.
	~OnlineEngine ()
	Destroys the Inference pointer associated with this OnlineEngine.
void	init ()
	Initializes the underlying inference procedure.
void	infer (vector< string > &nonZeroAtoms, vector< float > &probs)
	Perform inference given the current evidence and queries.
void	addTrueEvidence (const vector< string > &evidence)
	Add true evidence to the underlying state.
void	addFalseEvidence (const vector< string > &evidence)
	Add false evidence to the underlying state.
void	removeEvidence (const vector< string > &oldEvidence)
	Remove evidence from the underlying state.
void	setInference (Inference *inference)
	Sets the inference procedure for this OnlineEngine.
void	setMaxInferenceSteps (const int &inferenceSteps)
	Sets the max number of steps for the inference procedure if using MaxWalkSat.

---

Detailed Description

Engine for performing inference and learning online.

This class is designed to be used with an external agent which initializes the engine with an mln, evidence predicates, a set of queries and parameters for the inference procedure as a string in the same form used by the infer executable. The agent then sends the engine changes in evidence and asks the engine to perform inference and/or learning.

Definition at line 268 of file onlineengine.h.

---

Constructor & Destructor Documentation

OnlineEngine::OnlineEngine

(

const string &

inferString

)

[inline]

Constructs an OnlineEngine from a string of inference options.

Parameters:

inferString

string containing parameters for the inference procedure. The form is identical to that given to the infer executable.

Definition at line 278 of file onlineengine.h.

References setInference().

  {
    Inference* inference = NULL;
    parseInferString(inferString, inference);
    setInference(inference);
  }

OnlineEngine::OnlineEngine

(

Inference *

inference

)

[inline]

Constructs an OnlineEngine from an Inference object.

Parameters:

inference

Inference used in the OnlineEngine

Definition at line 290 of file onlineengine.h.

References setInference().

  {
    setInference(inference);
  }

---

Member Function Documentation

void OnlineEngine::infer	(	vector< string > &	nonZeroAtoms,
		vector< float > &	probs
	)			[inline]

Perform inference given the current evidence and queries.

Parameters:

	nonZeroAtoms	For MAP inference, this contains the query atoms inferred to be true; for prob. inference, this contains the query atoms with non-zero probability.
	probs	For MAP inference, this is a vector of ones; for prob. inference, this contains the probabilities corresponding to the atoms in trueAtoms.

Definition at line 321 of file onlineengine.h.

References Inference::infer().

  {
    nonZeroAtoms.clear();
    probs.clear();
    inference_->infer();
      // Fill in vectors
    inference_->getPredsWithNonZeroProb(nonZeroAtoms, probs);
    assert(nonZeroAtoms.size() == probs.size());
  }

void OnlineEngine::addTrueEvidence

(

const vector< string > &

evidence

)

[inline]

Add true evidence to the underlying state.

The given atoms are marked as true evidence in the database.

Parameters:

evidence

Atoms, in string form, to be added to the evidence.

Definition at line 337 of file onlineengine.h.

  {
    addRemoveEvidenceHelper(evidence, true, true);
  }

void OnlineEngine::addFalseEvidence

(

const vector< string > &

evidence

)

[inline]

Add false evidence to the underlying state.

The given atoms are marked as false evidence in the database.

Parameters:

evidence

Atoms, in string form, to be added to the evidence.

Definition at line 348 of file onlineengine.h.

  {
    addRemoveEvidenceHelper(evidence, true, false);
  }

void OnlineEngine::removeEvidence

(

const vector< string > &

oldEvidence

)

[inline]

Remove evidence from the underlying state.

The given atoms are marked as unknown in the database.

Parameters:

oldEvidence

Atoms, in string form, to be removed from the evidence.

Definition at line 359 of file onlineengine.h.

  {
    addRemoveEvidenceHelper(oldEvidence, false, false);
  }

void OnlineEngine::setInference

(

Inference *

inference

)

[inline]

Sets the inference procedure for this OnlineEngine.

Parameters:

inference

Inference procedure for this OnlineEngine.

Definition at line 369 of file onlineengine.h.

Referenced by OnlineEngine().

  {
    inference_ = inference;
  }

void OnlineEngine::setMaxInferenceSteps

(

const int &

inferenceSteps

)

[inline]

Sets the max number of steps for the inference procedure if using MaxWalkSat.

It is typical to set the number of steps to a lower value after the first step.

Parameters:

inferenceSteps

Number of maximum steps MaxWalkSat should perform.

Definition at line 381 of file onlineengine.h.

  {
      // Check if using MWS
    if (MaxWalkSat* mws = dynamic_cast<MaxWalkSat*>(inference_))
    {
      mws->setMaxSteps(inferenceSteps);
    }    
  }

---

The documentation for this class was generated from the following file:

• src/online/onlineengine.h

---