SmartEngine  1.6.0
Public Member Functions | List of all members
SmartEngine::IRLTrainer Class Referenceabstract

Base class for all reinforcement learning trainers. More...

#include <RLTrainer.h>

Inheritance diagram for SmartEngine::IRLTrainer:
SmartEngine::IObject SmartEngine::IAgentFactory SmartEngine::IResource SmartEngine::IObject SmartEngine::IObject SmartEngine::ISerializable SmartEngine::IObject SmartEngine::IA2CTrainer SmartEngine::ID4PGTrainer SmartEngine::IPPOTrainer

Public Member Functions

virtual int GetGenerationCount () const =0
 Returns how many generations we have trained More...
 
virtual float GetLoss ()=0
 This value will mean different things to different trainers. See each trainer's description for the value returned. More...
 
virtual void Reset ()=0
 Resets the trainer to a fresh state, initializing any internal weights to random values. More...
 
virtual void Step ()=0
 Step training. May not actual result in any training if there is not enough data available yet. More...
 
- Public Member Functions inherited from SmartEngine::IObject
virtual ObjectId GetId () const =0
 Returns the ID of this object. More...
 
virtual void AddRef () const =0
 Increments the internal reference count on this object. It is not common to use this method directly. More...
 
virtual void Release () const =0
 Decrements the internal reference count on this object. It is not common to use this method directly. More...
 
virtual int GetRefCount () const =0
 Returns the number of references to this object. More...
 
virtual void * QueryInterface (ObjectClassId id)=0
 Queries the object for an interface and returns a pointer to that interface if found. More...
 
void operator= (IObject const &x)=delete
 
- Public Member Functions inherited from SmartEngine::IAgentFactory
virtual ObjectPtr< IAgentCreateAgent ()=0
 Creates an agent for a particular trainer. More...
 
- Public Member Functions inherited from SmartEngine::IResource
virtual const char * GetResourceName () const =0
 Returns the name of this resource passed to the constructor. More...
 
virtual SerializationResult GetLastLoadResult () const =0
 Returns the result of the last call to Load(). Useful for checking loaded data state after creation. More...
 
virtual SerializationResult Load (const char *appendName=nullptr)=0
 Load this object from disk. More...
 
virtual SerializationResult Save (const char *appendName=nullptr)=0
 Save this object to disk. More...
 
- Public Member Functions inherited from SmartEngine::ISerializable
virtual SerializationResult Serialize (IMemoryBuffer *buffer)=0
 Write the contents of this object to a buffer. More...
 
virtual SerializationResult Deserialize (IMemoryBuffer *buffer)=0
 Fill this object with contents from a buffer. More...
 

Additional Inherited Members

- Public Attributes inherited from SmartEngine::IObject
 private
 
 __pad0__: IObject() {} IObject(IObject const&) = delete
 

Detailed Description

Base class for all reinforcement learning trainers.

Member Function Documentation

◆ GetGenerationCount()

virtual int SmartEngine::IRLTrainer::GetGenerationCount ( ) const
pure virtual

Returns how many generations we have trained

◆ GetLoss()

virtual float SmartEngine::IRLTrainer::GetLoss ( )
pure virtual

This value will mean different things to different trainers. See each trainer's description for the value returned.

◆ Reset()

virtual void SmartEngine::IRLTrainer::Reset ( )
pure virtual

Resets the trainer to a fresh state, initializing any internal weights to random values.

◆ Step()

virtual void SmartEngine::IRLTrainer::Step ( )
pure virtual

Step training. May not actual result in any training if there is not enough data available yet.