mirror of
https://github.com/nomic-ai/gpt4all.git
synced 2024-10-01 01:06:10 -04:00
251 lines
8.2 KiB
C++
251 lines
8.2 KiB
C++
#ifndef CHATLLM_H
|
||
#define CHATLLM_H
|
||
|
||
#include "database.h" // IWYU pragma: keep
|
||
#include "modellist.h"
|
||
|
||
#include <gpt4all-backend/llmodel.h>
|
||
|
||
#include <QByteArray>
|
||
#include <QElapsedTimer>
|
||
#include <QFileInfo>
|
||
#include <QList>
|
||
#include <QObject>
|
||
#include <QPair>
|
||
#include <QString>
|
||
#include <QThread>
|
||
#include <QVariantMap>
|
||
#include <QVector>
|
||
#include <QtGlobal>
|
||
|
||
#include <atomic>
|
||
#include <cstdint>
|
||
#include <memory>
|
||
#include <optional>
|
||
#include <string>
|
||
|
||
using namespace Qt::Literals::StringLiterals;
|
||
|
||
class QDataStream;
|
||
|
||
// NOTE: values serialized to disk, do not change or reuse
|
||
enum LLModelType {
|
||
GPTJ_ = 0, // no longer used
|
||
LLAMA_ = 1,
|
||
API_ = 2,
|
||
BERT_ = 3, // no longer used
|
||
};
|
||
|
||
class ChatLLM;
|
||
|
||
struct LLModelInfo {
|
||
std::unique_ptr<LLModel> model;
|
||
QFileInfo fileInfo;
|
||
std::optional<QString> fallbackReason;
|
||
|
||
// NOTE: This does not store the model type or name on purpose as this is left for ChatLLM which
|
||
// must be able to serialize the information even if it is in the unloaded state
|
||
|
||
void resetModel(ChatLLM *cllm, LLModel *model = nullptr);
|
||
};
|
||
|
||
class TokenTimer : public QObject {
|
||
Q_OBJECT
|
||
public:
|
||
explicit TokenTimer(QObject *parent)
|
||
: QObject(parent)
|
||
, m_elapsed(0) {}
|
||
|
||
static int rollingAverage(int oldAvg, int newNumber, int n)
|
||
{
|
||
// i.e. to calculate the new average after then nth number,
|
||
// you multiply the old average by n−1, add the new number, and divide the total by n.
|
||
return qRound(((float(oldAvg) * (n - 1)) + newNumber) / float(n));
|
||
}
|
||
|
||
void start() { m_tokens = 0; m_elapsed = 0; m_time.invalidate(); }
|
||
void stop() { handleTimeout(); }
|
||
void inc() {
|
||
if (!m_time.isValid())
|
||
m_time.start();
|
||
++m_tokens;
|
||
if (m_time.elapsed() > 999)
|
||
handleTimeout();
|
||
}
|
||
|
||
Q_SIGNALS:
|
||
void report(const QString &speed);
|
||
|
||
private Q_SLOTS:
|
||
void handleTimeout()
|
||
{
|
||
m_elapsed += m_time.restart();
|
||
emit report(u"%1 tokens/sec"_s.arg(m_tokens / float(m_elapsed / 1000.0f), 0, 'g', 2));
|
||
}
|
||
|
||
private:
|
||
QElapsedTimer m_time;
|
||
qint64 m_elapsed;
|
||
quint32 m_tokens;
|
||
};
|
||
|
||
class Chat;
|
||
class ChatLLM : public QObject
|
||
{
|
||
Q_OBJECT
|
||
Q_PROPERTY(bool restoringFromText READ restoringFromText NOTIFY restoringFromTextChanged)
|
||
Q_PROPERTY(QString deviceBackend READ deviceBackend NOTIFY loadedModelInfoChanged)
|
||
Q_PROPERTY(QString device READ device NOTIFY loadedModelInfoChanged)
|
||
Q_PROPERTY(QString fallbackReason READ fallbackReason NOTIFY loadedModelInfoChanged)
|
||
public:
|
||
ChatLLM(Chat *parent, bool isServer = false);
|
||
virtual ~ChatLLM();
|
||
|
||
void destroy();
|
||
static void destroyStore();
|
||
bool isModelLoaded() const;
|
||
void regenerateResponse();
|
||
void resetResponse();
|
||
void resetContext();
|
||
|
||
void stopGenerating() { m_stopGenerating = true; }
|
||
|
||
bool shouldBeLoaded() const { return m_shouldBeLoaded; }
|
||
void setShouldBeLoaded(bool b);
|
||
void requestTrySwitchContext();
|
||
void setForceUnloadModel(bool b) { m_forceUnloadModel = b; }
|
||
void setMarkedForDeletion(bool b) { m_markedForDeletion = b; }
|
||
|
||
QString response(bool trim = true) const;
|
||
|
||
ModelInfo modelInfo() const;
|
||
void setModelInfo(const ModelInfo &info);
|
||
|
||
bool restoringFromText() const { return m_restoringFromText; }
|
||
|
||
void acquireModel();
|
||
void resetModel();
|
||
|
||
QString deviceBackend() const
|
||
{
|
||
if (!isModelLoaded()) return QString();
|
||
std::string name = LLModel::GPUDevice::backendIdToName(m_llModelInfo.model->backendName());
|
||
return QString::fromStdString(name);
|
||
}
|
||
|
||
QString device() const
|
||
{
|
||
if (!isModelLoaded()) return QString();
|
||
const char *name = m_llModelInfo.model->gpuDeviceName();
|
||
return name ? QString(name) : u"CPU"_s;
|
||
}
|
||
|
||
// not loaded -> QString(), no fallback -> QString("")
|
||
QString fallbackReason() const
|
||
{
|
||
if (!isModelLoaded()) return QString();
|
||
return m_llModelInfo.fallbackReason.value_or(u""_s);
|
||
}
|
||
|
||
QString generatedName() const { return QString::fromStdString(m_nameResponse); }
|
||
|
||
bool serialize(QDataStream &stream, int version, bool serializeKV);
|
||
bool deserialize(QDataStream &stream, int version, bool deserializeKV, bool discardKV);
|
||
void setStateFromText(const QVector<QPair<QString, QString>> &stateFromText) { m_stateFromText = stateFromText; }
|
||
|
||
public Q_SLOTS:
|
||
bool prompt(const QList<QString> &collectionList, const QString &prompt);
|
||
bool loadDefaultModel();
|
||
void trySwitchContextOfLoadedModel(const ModelInfo &modelInfo);
|
||
bool loadModel(const ModelInfo &modelInfo);
|
||
void modelChangeRequested(const ModelInfo &modelInfo);
|
||
void unloadModel();
|
||
void reloadModel();
|
||
void generateName();
|
||
void generateQuestions(qint64 elapsed);
|
||
void handleChatIdChanged(const QString &id);
|
||
void handleShouldBeLoadedChanged();
|
||
void handleThreadStarted();
|
||
void handleForceMetalChanged(bool forceMetal);
|
||
void handleDeviceChanged();
|
||
void processSystemPrompt();
|
||
void processRestoreStateFromText();
|
||
|
||
Q_SIGNALS:
|
||
void restoringFromTextChanged();
|
||
void loadedModelInfoChanged();
|
||
void modelLoadingPercentageChanged(float);
|
||
void modelLoadingError(const QString &error);
|
||
void modelLoadingWarning(const QString &warning);
|
||
void responseChanged(const QString &response);
|
||
void promptProcessing();
|
||
void generatingQuestions();
|
||
void responseStopped(qint64 promptResponseMs);
|
||
void generatedNameChanged(const QString &name);
|
||
void generatedQuestionFinished(const QString &generatedQuestion);
|
||
void stateChanged();
|
||
void threadStarted();
|
||
void shouldBeLoadedChanged();
|
||
void trySwitchContextRequested(const ModelInfo &modelInfo);
|
||
void trySwitchContextOfLoadedModelCompleted(int value);
|
||
void requestRetrieveFromDB(const QList<QString> &collections, const QString &text, int retrievalSize, QList<ResultInfo> *results);
|
||
void reportSpeed(const QString &speed);
|
||
void reportDevice(const QString &device);
|
||
void reportFallbackReason(const QString &fallbackReason);
|
||
void databaseResultsChanged(const QList<ResultInfo>&);
|
||
void modelInfoChanged(const ModelInfo &modelInfo);
|
||
|
||
protected:
|
||
bool promptInternal(const QList<QString> &collectionList, const QString &prompt, const QString &promptTemplate,
|
||
int32_t n_predict, int32_t top_k, float top_p, float min_p, float temp, int32_t n_batch, float repeat_penalty,
|
||
int32_t repeat_penalty_tokens, std::optional<QString> fakeReply = {});
|
||
bool handlePrompt(int32_t token);
|
||
bool handleResponse(int32_t token, const std::string &response);
|
||
bool handleNamePrompt(int32_t token);
|
||
bool handleNameResponse(int32_t token, const std::string &response);
|
||
bool handleSystemPrompt(int32_t token);
|
||
bool handleSystemResponse(int32_t token, const std::string &response);
|
||
bool handleRestoreStateFromTextPrompt(int32_t token);
|
||
bool handleRestoreStateFromTextResponse(int32_t token, const std::string &response);
|
||
bool handleQuestionPrompt(int32_t token);
|
||
bool handleQuestionResponse(int32_t token, const std::string &response);
|
||
void saveState();
|
||
void restoreState();
|
||
|
||
protected:
|
||
LLModel::PromptContext m_ctx;
|
||
quint32 m_promptTokens;
|
||
quint32 m_promptResponseTokens;
|
||
|
||
private:
|
||
bool loadNewModel(const ModelInfo &modelInfo, QVariantMap &modelLoadProps);
|
||
|
||
std::string m_response;
|
||
std::string m_trimmedResponse;
|
||
std::string m_nameResponse;
|
||
QString m_questionResponse;
|
||
LLModelInfo m_llModelInfo;
|
||
LLModelType m_llModelType;
|
||
ModelInfo m_modelInfo;
|
||
TokenTimer *m_timer;
|
||
QByteArray m_state;
|
||
QThread m_llmThread;
|
||
std::atomic<bool> m_stopGenerating;
|
||
std::atomic<bool> m_shouldBeLoaded;
|
||
std::atomic<bool> m_restoringFromText; // status indication
|
||
std::atomic<bool> m_forceUnloadModel;
|
||
std::atomic<bool> m_markedForDeletion;
|
||
bool m_isServer;
|
||
bool m_forceMetal;
|
||
bool m_reloadingToChangeVariant;
|
||
bool m_processedSystemPrompt;
|
||
bool m_restoreStateFromText;
|
||
// m_pristineLoadedState is set if saveSate is unnecessary, either because:
|
||
// - an unload was queued during LLModel::restoreState()
|
||
// - the chat will be restored from text and hasn't been interacted with yet
|
||
bool m_pristineLoadedState = false;
|
||
QVector<QPair<QString, QString>> m_stateFromText;
|
||
};
|
||
|
||
#endif // CHATLLM_H
|