bitrl & cuberl Documentation
Simulation engine for reinforcement learning agents
Loading...
Searching...
No Matches
bitrl::network::TensorboardServer Class Reference

class TensorboardServer More...

#include <tensorboard_server.h>

Inheritance diagram for bitrl::network::TensorboardServer:
Collaboration diagram for bitrl::network::TensorboardServer:

Public Member Functions

 TensorboardServer (const std::string &api_url)
 Constructor.
 
void init (const std::string &log_dir)
 Set the log_dir for this instance.
 
void close ()
 Close the TensorboardServer.
 
void add_scalar (const std::string &tag, real_t value, uint_t step_idx=bitrl::consts::INVALID_ID) const
 Add scalar.
 
void add_scalars (const std::string &main_tag, const std::unordered_map< std::string, real_t > &values, uint_t step_idx=bitrl::consts::INVALID_ID) const
 Add scalar.
 
void add_text (const std::string &tag, const std::string &text, uint_t step_idx=bitrl::consts::INVALID_ID) const
 Add scalar.
 
std::string_view get_log_dir_path () const noexcept
 Return the directory for logging.
 
std::string_view get_server_address () const noexcept
 Return the server address.
 

Detailed Description

Constructor & Destructor Documentation

◆ TensorboardServer()

bitrl::network::TensorboardServer::TensorboardServer ( const std::string &  api_url)

Constructor.

Member Function Documentation

◆ add_scalar()

void bitrl::network::TensorboardServer::add_scalar ( const std::string &  tag,
real_t  value,
uint_t  step_idx = bitrl::consts::INVALID_ID 
) const

Add scalar.

◆ add_scalars()

void bitrl::network::TensorboardServer::add_scalars ( const std::string &  main_tag,
const std::unordered_map< std::string, real_t > &  values,
uint_t  step_idx = bitrl::consts::INVALID_ID 
) const

Add scalar.

◆ add_text()

void bitrl::network::TensorboardServer::add_text ( const std::string &  tag,
const std::string &  text,
uint_t  step_idx = bitrl::consts::INVALID_ID 
) const

Add scalar.

◆ close()

void bitrl::network::TensorboardServer::close ( )

Close the TensorboardServer.

◆ get_log_dir_path()

std::string_view bitrl::network::TensorboardServer::get_log_dir_path ( ) const
inlinenoexcept

Return the directory for logging.

◆ get_server_address()

std::string_view bitrl::network::TensorboardServer::get_server_address ( ) const
inlinenoexcept

Return the server address.

◆ init()

void bitrl::network::TensorboardServer::init ( const std::string &  log_dir)

Set the log_dir for this instance.


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