YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Llama2Device Class Reference

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-llama2/src/devices/llama2Device/Llama2Device.h>

+ Inheritance diagram for Llama2Device:

Public Member Functions

 Llama2Device ()
 
 Llama2Device (const Llama2Device &)=delete
 
 Llama2Device (Llama2Device &&) noexcept=delete
 
Llama2Device & operator= (const Llama2Device &)=delete
 
Llama2Device & operator= (Llama2Device &&) noexcept=delete
 
 ~Llama2Device () override=default
 
yarp::dev::ReturnValue setPrompt (const std::string &prompt) override
 Performs a question.
 
yarp::dev::ReturnValue readPrompt (std::string &oPrompt) override
 Retrieves the provided prompt.
 
yarp::dev::ReturnValue ask (const std::string &question, yarp::dev::LLM_Message &oAnswer) override
 Performs a question.
 
yarp::dev::ReturnValue getConversation (std::vector< yarp::dev::LLM_Message > &oConversation) override
 Retrieves the whole conversation.
 
yarp::dev::ReturnValue deleteConversation () noexcept override
 Delete the conversation and clear the system context from any internally stored context.
 
yarp::dev::ReturnValue refreshConversation () noexcept override
 Refresh the conversation.
 
yarp::dev::ReturnValue init_LLM (const std::string &model_path)
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
void help ()
 
void convAdd (std::vector< yarp::dev::LLM_Message > &conversation, const std::string &type, const std::string &content)
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriver & operator= (const DeviceDriver &other)=delete
 
DeviceDriver & operator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDriver * getImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from Llama2Device_ParamsParser
 Llama2Device_ParamsParser ()
 
 ~Llama2Device_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 
- Public Member Functions inherited from yarp::dev::ILLM
virtual ~ILLM ()
 Destructor.
 

Additional Inherited Members

- Public Attributes inherited from Llama2Device_ParamsParser
const std::string m_device_classname = {"Llama2Device"}
 
const std::string m_device_name = {"yarp_llama2Device"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_model_context_defaultValue = {""}
 
const std::string m_model_name_defaultValue = {""}
 
const std::string m_npredict_defaultValue = {"128"}
 
const std::string m_ngl_defaultValue = {"50"}
 
const std::string m_offload_gpu_defaultValue = {"true"}
 
const std::string m_context_defaultValue = {"4096"}
 
const std::string m_prompt_file_defaultValue = {""}
 
const std::string m_prompt_context_defaultValue = {""}
 
std::string m_model_context = {}
 
std::string m_model_name = {}
 
int m_npredict = {128}
 
int m_ngl = {50}
 
bool m_offload_gpu = {true}
 
int m_context = {4096}
 
std::string m_prompt_file = {}
 
std::string m_prompt_context = {}
 

Detailed Description

Definition at line 32 of file Llama2Device.h.

Constructor & Destructor Documentation

◆ Llama2Device() [1/3]

Llama2Device::Llama2Device ( )

Definition at line 31 of file Llama2Device.cpp.

◆ Llama2Device() [2/3]

Llama2Device::Llama2Device ( const Llama2Device &  )
delete

◆ Llama2Device() [3/3]

Llama2Device::Llama2Device ( Llama2Device &&  )
deletenoexcept

◆ ~Llama2Device()

Llama2Device::~Llama2Device ( )
overridedefault

Member Function Documentation

◆ ask()

yarp::dev::ReturnValue Llama2Device::ask ( const std::string &  question,
yarp::dev::LLM_Message &  answer 
)
overridevirtual

Performs a question.

Parameters
questionthe text of the question provided by the user
answerthe returned answer
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 91 of file Llama2Device.cpp.

◆ close()

bool Llama2Device::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 217 of file Llama2Device.cpp.

◆ convAdd()

void Llama2Device::convAdd ( std::vector< yarp::dev::LLM_Message > &  conversation,
const std::string &  type,
const std::string &  content 
)

◆ deleteConversation()

yarp::dev::ReturnValue Llama2Device::deleteConversation ( )
overridevirtualnoexcept

Delete the conversation and clear the system context from any internally stored context.

Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 196 of file Llama2Device.cpp.

◆ getConversation()

yarp::dev::ReturnValue Llama2Device::getConversation ( std::vector< yarp::dev::LLM_Message > &  conversation)
overridevirtual

Retrieves the whole conversation.

Parameters
conversationthe conversation
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 175 of file Llama2Device.cpp.

◆ help()

void Llama2Device::help ( )

Definition at line 223 of file Llama2Device.cpp.

◆ init_LLM()

yarp::dev::ReturnValue Llama2Device::init_LLM ( const std::string &  model_path)

Definition at line 83 of file Llama2Device.cpp.

◆ open()

bool Llama2Device::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 36 of file Llama2Device.cpp.

◆ operator=() [1/2]

Llama2Device & Llama2Device::operator= ( const Llama2Device &  )
delete

◆ operator=() [2/2]

Llama2Device & Llama2Device::operator= ( Llama2Device &&  )
deletenoexcept

◆ readPrompt()

yarp::dev::ReturnValue Llama2Device::readPrompt ( std::string &  oPrompt)
overridevirtual

Retrieves the provided prompt.

Parameters
promptthe stored prompt
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 161 of file Llama2Device.cpp.

◆ refreshConversation()

yarp::dev::ReturnValue Llama2Device::refreshConversation ( )
overridevirtualnoexcept

Refresh the conversation.

Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 212 of file Llama2Device.cpp.

◆ setPrompt()

yarp::dev::ReturnValue Llama2Device::setPrompt ( const std::string &  prompt)
overridevirtual

Performs a question.

Parameters
promptprovides a prompt to the LLM
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 137 of file Llama2Device.cpp.


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