###### # Project : GPT4ALL-UI # Author : ParisNeo with the help of the community # Supported by Nomic-AI # license : Apache 2.0 # Description : # A front end Flask application for llamacpp models. # The official GPT4All Web ui # Made by the community for the community ###### __author__ = "parisneo" __github__ = "https://github.com/nomic-ai/gpt4all-ui" __copyright__ = "Copyright 2023, " __license__ = "Apache 2.0" import os import logging import argparse import json import re import traceback import sys from tqdm import tqdm import subprocess import signal from pyaipersonality import AIPersonality from gpt4all_api.db import DiscussionsDB, Discussion from flask import ( Flask, Response, jsonify, render_template, request, stream_with_context, send_from_directory ) from flask_socketio import SocketIO, emit from pathlib import Path import gc import yaml from geventwebsocket.handler import WebSocketHandler from gevent.pywsgi import WSGIServer import requests from concurrent.futures import ThreadPoolExecutor, as_completed import logging log = logging.getLogger('werkzeug') log.setLevel(logging.ERROR) app = Flask("GPT4All-WebUI", static_url_path="/static", static_folder="static") socketio = SocketIO(app, cors_allowed_origins="*", async_mode='gevent', ping_timeout=200, ping_interval=15) app.config['SECRET_KEY'] = 'secret!' # Set the logging level to WARNING or higher logging.getLogger('socketio').setLevel(logging.WARNING) logging.getLogger('engineio').setLevel(logging.WARNING) logging.getLogger('werkzeug').setLevel(logging.ERROR) logging.basicConfig(level=logging.WARNING) import time from gpt4all_api.config import load_config, save_config from gpt4all_api.api import GPT4AllAPI import shutil import markdown class Gpt4AllWebUI(GPT4AllAPI): def __init__(self, _app, _socketio, config:dict, config_file_path) -> None: super().__init__(config, _socketio, config_file_path) self.app = _app self.cancel_gen = False if "use_new_ui" in self.config: if self.config["use_new_ui"]: app.template_folder = "web/dist" # ========================================================================================= # Endpoints # ========================================================================================= self.add_endpoint( "/list_backends", "list_backends", self.list_backends, methods=["GET"] ) self.add_endpoint( "/list_models", "list_models", self.list_models, methods=["GET"] ) self.add_endpoint( "/list_personalities_languages", "list_personalities_languages", self.list_personalities_languages, methods=["GET"] ) self.add_endpoint( "/list_personalities_categories", "list_personalities_categories", self.list_personalities_categories, methods=["GET"] ) self.add_endpoint( "/list_personalities", "list_personalities", self.list_personalities, methods=["GET"] ) self.add_endpoint( "/list_languages", "list_languages", self.list_languages, methods=["GET"] ) self.add_endpoint( "/list_discussions", "list_discussions", self.list_discussions, methods=["GET"] ) self.add_endpoint("/set_personality_language", "set_personality_language", self.set_personality_language, methods=["GET"]) self.add_endpoint("/set_personality_category", "set_personality_category", self.set_personality_category, methods=["GET"]) self.add_endpoint("/", "", self.index, methods=["GET"]) self.add_endpoint("/", "serve_static", self.serve_static, methods=["GET"]) self.add_endpoint("/personalities/", "serve_personalities", self.serve_personalities, methods=["GET"]) self.add_endpoint("/outputs/", "serve_outputs", self.serve_outputs, methods=["GET"]) self.add_endpoint("/export_discussion", "export_discussion", self.export_discussion, methods=["GET"]) self.add_endpoint("/export", "export", self.export, methods=["GET"]) self.add_endpoint( "/new_discussion", "new_discussion", self.new_discussion, methods=["GET"] ) self.add_endpoint("/stop_gen", "stop_gen", self.stop_gen, methods=["GET"]) self.add_endpoint("/rename", "rename", self.rename, methods=["POST"]) self.add_endpoint("/edit_title", "edit_title", self.edit_title, methods=["POST"]) self.add_endpoint( "/load_discussion", "load_discussion", self.load_discussion, methods=["POST"] ) self.add_endpoint( "/delete_discussion", "delete_discussion", self.delete_discussion, methods=["POST"], ) self.add_endpoint( "/update_message", "update_message", self.update_message, methods=["GET"] ) self.add_endpoint( "/message_rank_up", "message_rank_up", self.message_rank_up, methods=["GET"] ) self.add_endpoint( "/message_rank_down", "message_rank_down", self.message_rank_down, methods=["GET"] ) self.add_endpoint( "/delete_message", "delete_message", self.delete_message, methods=["GET"] ) self.add_endpoint( "/set_backend", "set_backend", self.set_backend, methods=["POST"] ) self.add_endpoint( "/set_model", "set_model", self.set_model, methods=["POST"] ) self.add_endpoint( "/update_model_params", "update_model_params", self.update_model_params, methods=["POST"] ) self.add_endpoint( "/get_config", "get_config", self.get_config, methods=["GET"] ) self.add_endpoint( "/get_available_models", "get_available_models", self.get_available_models, methods=["GET"] ) self.add_endpoint( "/extensions", "extensions", self.extensions, methods=["GET"] ) self.add_endpoint( "/training", "training", self.training, methods=["GET"] ) self.add_endpoint( "/main", "main", self.main, methods=["GET"] ) self.add_endpoint( "/settings", "settings", self.settings, methods=["GET"] ) self.add_endpoint( "/help", "help", self.help, methods=["GET"] ) self.add_endpoint( "/get_generation_status", "get_generation_status", self.get_generation_status, methods=["GET"] ) self.add_endpoint( "/update_setting", "update_setting", self.update_setting, methods=["POST"] ) self.add_endpoint( "/apply_settings", "apply_settings", self.apply_settings, methods=["POST"] ) self.add_endpoint( "/save_settings", "save_settings", self.save_settings, methods=["POST"] ) self.add_endpoint( "/get_current_personality", "get_current_personality", self.get_current_personality, methods=["GET"] ) self.add_endpoint( "/get_all_personalities", "get_all_personalities", self.get_all_personalities, methods=["GET"] ) self.add_endpoint( "/reset", "reset", self.reset, methods=["GET"] ) def reset(self): os.kill(os.getpid(), signal.SIGINT) # Send the interrupt signal to the current process subprocess.Popen(['python', 'your_app.py']) # Restart the app using subprocess return 'App is resetting...' def save_settings(self): save_config(self.config, self.config_file_path) if self.config["debug"]: print("Configuration saved") # Tell that the setting was changed self.socketio.emit('save_settings', {"status":True}) return jsonify({"status":True}) def get_current_personality(self): return jsonify({"personality":self.personality.as_dict()}) def get_all_personalities(self): personalities_folder = Path("./personalities") personalities = {} for language_folder in personalities_folder.iterdir(): if language_folder.is_dir(): personalities[language_folder.name] = {} for category_folder in language_folder.iterdir(): if category_folder.is_dir(): personalities[language_folder.name][category_folder.name] = [] for personality_folder in category_folder.iterdir(): if personality_folder.is_dir(): personality_info = {} config_path = personality_folder / 'config.yaml' with open(config_path) as config_file: config_data = yaml.load(config_file, Loader=yaml.FullLoader) personality_info['name'] = personality_folder.name personality_info['description'] = config_data['description'] personality_info['author'] = config_data['creator'] personality_info['version'] = config_data['version'] scripts_path = personality_folder / 'scripts' personality_info['has_scripts'] = scripts_path.is_dir() assets_path = personality_folder / 'assets' logo_path = assets_path / 'logo.png' gif_logo_path = assets_path / 'logo.gif' personality_info['has_logo'] = logo_path.is_file() or gif_logo_path.is_file() if logo_path.is_file(): personality_info['icon_file'] = 'logo.png' elif gif_logo_path.is_file(): personality_info['icon_file'] = 'logo.gif' personalities[language_folder.name][category_folder.name].append(personality_info) return json.dumps(personalities) # Settings (data: {"setting_name":,"setting_value":}) def update_setting(self): data = request.get_json() setting_name = data['setting_name'] if setting_name== "temperature": self.config["temperature"]=float(data['setting_value']) elif setting_name== "n_predict": self.config["n_predict"]=int(data['setting_value']) elif setting_name== "top_k": self.config["top_k"]=int(data['setting_value']) elif setting_name== "top_p": self.config["top_p"]=float(data['setting_value']) elif setting_name== "repeat_penalty": self.config["repeat_penalty"]=float(data['setting_value']) elif setting_name== "repeat_last_n": self.config["repeat_last_n"]=int(data['setting_value']) elif setting_name== "n_threads": self.config["n_threads"]=int(data['setting_value']) elif setting_name== "ctx_size": self.config["ctx_size"]=int(data['setting_value']) elif setting_name== "language": self.config["language"]=data['setting_value'] elif setting_name== "personality_language": back_language = self.config["personality_language"] if self.config["personality_language"]!=data['setting_value']: self.config["personality_language"]=data['setting_value'] cats = self.list_personalities_categories() if len(cats)>0: back_category = self.config["personality_category"] self.config["personality_category"]=cats[0] pers = json.loads(self.list_personalities().data.decode("utf8")) if len(pers)>0: self.config["personality"]=pers[0] personality_fn = f"personalities/{self.config['personality_language']}/{self.config['personality_category']}/{self.config['personality']}" self.personality.load_personality(personality_fn) else: self.config["personality_language"]=back_language self.config["personality_category"]=back_category return jsonify({'setting_name': data['setting_name'], "status":False}) else: self.config["personality_language"]=back_language return jsonify({'setting_name': data['setting_name'], "status":False}) elif setting_name== "personality_category": back_category = self.config["personality_category"] if self.config["personality_category"]!=data['setting_value']: self.config["personality_category"]=data['setting_value'] pers = json.loads(self.list_personalities().data.decode("utf8")) if len(pers)>0: self.config["personality"]=pers[0] personality_fn = f"personalities/{self.config['personality_language']}/{self.config['personality_category']}/{self.config['personality']}" self.personality.load_personality(personality_fn) if self.config["debug"]: print(self.personality) else: self.config["personality_category"]=back_category return jsonify({'setting_name': data['setting_name'], "status":False}) elif setting_name== "personality": self.config["personality"]=data['setting_value'] personality_fn = f"personalities/{self.config['personality_language']}/{self.config['personality_category']}/{self.config['personality']}" self.personality.load_personality(personality_fn) elif setting_name== "override_personality_model_parameters": self.config["override_personality_model_parameters"]=bool(data['setting_value']) elif setting_name== "model": self.config["model"]=data['setting_value'] print("update_settings : New model selected") elif setting_name== "backend": if self.config['backend']!= data['setting_value']: print("New backend selected") self.config["backend"]=data['setting_value'] try: self.backend = self.process.load_backend(self.config["backend"]) except Exception as ex: print("Couldn't build backend") return jsonify({'setting_name': data['setting_name'], "status":False, 'error':str(ex)}) else: if self.config["debug"]: print(f"Configuration {data['setting_name']} set to {data['setting_value']}") return jsonify({'setting_name': data['setting_name'], "status":True}) else: if self.config["debug"]: print(f"Configuration {data['setting_name']} couldn't be set to {data['setting_value']}") return jsonify({'setting_name': data['setting_name'], "status":False}) if self.config["debug"]: print(f"Configuration {data['setting_name']} set to {data['setting_value']}") print("Configuration updated") # Tell that the setting was changed return jsonify({'setting_name': data['setting_name'], "status":True}) def apply_settings(self): return jsonify(self.process.set_config(self.config)) def list_backends(self): backends_dir = Path('./backends') # replace with the actual path to the models folder backends = [f.stem for f in backends_dir.iterdir() if f.is_dir() and f.stem!="__pycache__"] return jsonify(backends) def list_models(self): if self.backend is not None: models = self.backend.list_models(self.config) return jsonify(models) else: return jsonify([]) def list_personalities_languages(self): personalities_languages_dir = Path(f'./personalities') # replace with the actual path to the models folder personalities_languages = [f.stem for f in personalities_languages_dir.iterdir() if f.is_dir()] return jsonify(personalities_languages) def list_personalities_categories(self): personalities_categories_dir = Path(f'./personalities/{self.config["personality_language"]}') # replace with the actual path to the models folder personalities_categories = [f.stem for f in personalities_categories_dir.iterdir() if f.is_dir()] return jsonify(personalities_categories) def list_personalities(self): try: personalities_dir = Path(f'./personalities/{self.config["personality_language"]}/{self.config["personality_category"]}') # replace with the actual path to the models folder personalities = [f.stem for f in personalities_dir.iterdir() if f.is_dir()] except Exception as ex: personalities=[] if self.config["debug"]: print(f"No personalities found. Using default one {ex}") return jsonify(personalities) def list_languages(self): lanuguages= [ { "value": "en-US", "label": "English" }, { "value": "fr-FR", "label": "Français" }, { "value": "ar-AR", "label": "العربية" }, { "value": "it-IT", "label": "Italiano" }, { "value": "de-DE", "label": "Deutsch" }, { "value": "nl-XX", "label": "Dutch" }, { "value": "zh-CN", "label": "中國人" } ] return jsonify(lanuguages) def list_discussions(self): discussions = self.db.get_discussions() return jsonify(discussions) def set_personality_language(self): lang = request.args.get('language') self.config['personality_language'] = lang return jsonify({'success':True}) def set_personality_category(self): category = request.args.get('category') self.config['personality_category'] = category return jsonify({'success':True}) def add_endpoint( self, endpoint=None, endpoint_name=None, handler=None, methods=["GET"], *args, **kwargs, ): self.app.add_url_rule( endpoint, endpoint_name, handler, methods=methods, *args, **kwargs ) def index(self): return render_template("index.html") def serve_static(self, filename): root_dir = os.getcwd() if "use_new_ui" in self.config: if self.config["use_new_ui"]: path = os.path.join(root_dir, 'web/dist/')+"/".join(filename.split("/")[:-1]) else: path = os.path.join(root_dir, 'static/')+"/".join(filename.split("/")[:-1]) else: path = os.path.join(root_dir, 'static/')+"/".join(filename.split("/")[:-1]) fn = filename.split("/")[-1] return send_from_directory(path, fn) def serve_personalities(self, filename): root_dir = os.getcwd() path = os.path.join(root_dir, 'personalities/')+"/".join(filename.split("/")[:-1]) fn = filename.split("/")[-1] return send_from_directory(path, fn) def serve_outputs(self, filename): root_dir = os.getcwd() path = os.path.join(root_dir, 'outputs/')+"/".join(filename.split("/")[:-1]) fn = filename.split("/")[-1] return send_from_directory(path, fn) def export(self): return jsonify(self.db.export_to_json()) def export_discussion(self): return jsonify({"discussion_text":self.get_discussion_to()}) def get_generation_status(self): return jsonify({"status":self.process.is_generating.value==1}) def stop_gen(self): self.cancel_gen = True self.process.cancel_generation() print("Stop generation received") return jsonify({"status": "ok"}) def rename(self): data = request.get_json() title = data["title"] self.current_discussion.rename(title) return "renamed successfully" def edit_title(self): data = request.get_json() title = data["title"] discussion_id = data["id"] self.current_discussion = Discussion(discussion_id, self.db) self.current_discussion.rename(title) return "title renamed successfully" def load_discussion(self): data = request.get_json() if "id" in data: discussion_id = data["id"] self.current_discussion = Discussion(discussion_id, self.db) else: if self.current_discussion is not None: discussion_id = self.current_discussion.discussion_id self.current_discussion = Discussion(discussion_id, self.db) else: self.current_discussion = self.db.create_discussion() messages = self.current_discussion.get_messages() return jsonify(messages), {'Content-Type': 'application/json; charset=utf-8'} def delete_discussion(self): data = request.get_json() discussion_id = data["id"] self.current_discussion = Discussion(discussion_id, self.db) self.current_discussion.delete_discussion() self.current_discussion = None return jsonify({}) def update_message(self): discussion_id = request.args.get("id") new_message = request.args.get("message") try: self.current_discussion.update_message(discussion_id, new_message) return jsonify({"status": "ok"}) except Exception as ex: return jsonify({"status": "nok", "error":str(ex)}) def message_rank_up(self): discussion_id = request.args.get("id") try: new_rank = self.current_discussion.message_rank_up(discussion_id) return jsonify({"status": "ok", "new_rank": new_rank}) except Exception as ex: return jsonify({"status": "nok", "error":str(ex)}) def message_rank_down(self): discussion_id = request.args.get("id") try: new_rank = self.current_discussion.message_rank_down(discussion_id) return jsonify({"status": "ok", "new_rank": new_rank}) except Exception as ex: return jsonify({"status": "nok", "error":str(ex)}) def delete_message(self): discussion_id = request.args.get("id") if self.current_discussion is None: return jsonify({"status": False,"message":"No discussion is selected"}) else: new_rank = self.current_discussion.delete_message(discussion_id) return jsonify({"status":True,"new_rank": new_rank}) def new_discussion(self): title = request.args.get("title") timestamp = self.create_new_discussion(title) # Return a success response return json.dumps({"id": self.current_discussion.discussion_id, "time": timestamp, "welcome_message":self.personality.welcome_message, "sender":self.personality.name}) def set_backend(self): data = request.get_json() backend = str(data["backend"]) if self.config['backend']!= backend: print("New backend selected") self.config['backend'] = backend backend_ =self.process.load_backend(config["backend"]) models = backend_.list_models(self.config) if len(models)>0: self.backend = backend_ self.config['model'] = models[0] # Build chatbot self.process.set_config(self.config) return jsonify({"status": "ok"}) else: return jsonify({"status": "no_models_found"}) return jsonify({"status": "error"}) def set_model(self): data = request.get_json() model = str(data["model"]) if self.config['model']!= model: print("set_model: New model selected") self.config['model'] = model # Build chatbot self.process.set_config(self.config) return jsonify({"status": "ok"}) return jsonify({"status": "error"}) def update_model_params(self): data = request.get_json() backend = str(data["backend"]) model = str(data["model"]) personality_language = str(data["personality_language"]) personality_category = str(data["personality_category"]) personality = str(data["personality"]) if self.config['backend']!=backend or self.config['model'] != model: print("update_model_params: New model selected") self.config['backend'] = backend self.config['model'] = model self.process.set_config(self.config) self.config['personality_language'] = personality_language self.config['personality_category'] = personality_category self.config['personality'] = personality personality_fn = f"personalities/{self.config['personality_language']}/{self.config['personality_category']}/{self.config['personality']}" print(f"Loading personality : {personality_fn}") self.config['n_predict'] = int(data["nPredict"]) self.config['seed'] = int(data["seed"]) self.config['model'] = str(data["model"]) self.config['voice'] = str(data["voice"]) self.config['language'] = str(data["language"]) self.config['temperature'] = float(data["temperature"]) self.config['top_k'] = int(data["topK"]) self.config['top_p'] = float(data["topP"]) self.config['repeat_penalty'] = float(data["repeatPenalty"]) self.config['repeat_last_n'] = int(data["repeatLastN"]) save_config(self.config, self.config_file_path) self.process.set_config(self.config) # Fixed missing argument self.backend = self.process.rebuild_backend(self.config) print("==============================================") print("Parameters changed to:") print(f"\tBackend:{self.config['backend']}") print(f"\tModel:{self.config['model']}") print(f"\tPersonality language:{self.config['personality_language']}") print(f"\tPersonality category:{self.config['personality_category']}") print(f"\tPersonality:{self.config['personality']}") print(f"\tLanguage:{self.config['language']}") print(f"\tVoice:{self.config['voice']}") print(f"\tTemperature:{self.config['temperature']}") print(f"\tNPredict:{self.config['n_predict']}") print(f"\tSeed:{self.config['seed']}") print(f"\top_k:{self.config['top_k']}") print(f"\top_p:{self.config['top_p']}") print(f"\trepeat_penalty:{self.config['repeat_penalty']}") print(f"\trepeat_last_n:{self.config['repeat_last_n']}") print("==============================================") return jsonify({"status":"ok"}) def get_available_models(self): """Get the available models Returns: _type_: _description_ """ if self.backend is None: return jsonify([]) model_list = self.backend.get_available_models() models = [] for model in model_list: try: filename = model.get('filename',"") server = model.get('server',"") image_url = model.get("image_url", '/icons/default.png') license = model.get("license", 'unknown') owner = model.get("owner", 'unknown') owner_link = model.get("owner_link", 'https://github.com/ParisNeo') filesize = int(model.get('filesize',0)) description = model.get('description',"") if server.endswith("/"): path = f'{server}{filename}' else: path = f'{server}/{filename}' local_path = Path(f'./models/{self.config["backend"]}/{filename}') is_installed = local_path.exists() models.append({ 'title': filename, 'icon': image_url, # Replace with the path to the model icon 'license': license, 'owner': owner, 'owner_link': owner_link, 'description': description, 'isInstalled': is_installed, 'path': path, 'filesize': filesize, }) except Exception as ex: print("#################################") print(ex) print("#################################") print(f"Problem with model : {model}") return jsonify(models) def get_config(self): return jsonify(self.config) def main(self): return render_template("main.html") def settings(self): return render_template("settings.html") def help(self): return render_template("help.html") def training(self): return render_template("training.html") def extensions(self): return render_template("extensions.html") if __name__ == "__main__": parser = argparse.ArgumentParser(description="Start the chatbot Flask app.") parser.add_argument( "-c", "--config", type=str, default="default", help="Sets the configuration file to be used." ) parser.add_argument( "-p", "--personality", type=str, default=None, help="Selects the personality to be using." ) parser.add_argument( "-s", "--seed", type=int, default=None, help="Force using a specific seed value." ) parser.add_argument( "-m", "--model", type=str, default=None, help="Force using a specific model." ) parser.add_argument( "--temp", type=float, default=None, help="Temperature parameter for the model." ) parser.add_argument( "--n_predict", type=int, default=None, help="Number of tokens to predict at each step.", ) parser.add_argument( "--n_threads", type=int, default=None, help="Number of threads to use.", ) parser.add_argument( "--top_k", type=int, default=None, help="Value for the top-k sampling." ) parser.add_argument( "--top_p", type=float, default=None, help="Value for the top-p sampling." ) parser.add_argument( "--repeat_penalty", type=float, default=None, help="Penalty for repeated tokens." ) parser.add_argument( "--repeat_last_n", type=int, default=None, help="Number of previous tokens to consider for the repeat penalty.", ) parser.add_argument( "--ctx_size", type=int, default=None,#2048, help="Size of the context window for the model.", ) parser.add_argument( "--debug", dest="debug", action="store_true", default=None, help="launch Flask server in debug mode", ) parser.add_argument( "--host", type=str, default=None, help="the hostname to listen on" ) parser.add_argument("--port", type=int, default=None, help="the port to listen on") parser.add_argument( "--db_path", type=str, default=None, help="Database path" ) args = parser.parse_args() # The default configuration must be kept unchanged as it is committed to the repository, # so we have to make a copy that is not comitted default_config = load_config(f"configs/default.yaml") if args.config=="default": args.config = "local_default" if not Path(f"configs/local_default.yaml").exists(): print("No local configuration file found. Building from scratch") shutil.copy(f"configs/default.yaml", f"configs/local_default.yaml") config_file_path = f"configs/{args.config}.yaml" config = load_config(config_file_path) if "version" not in config or int(config["version"])