symbolicai

symbolicai

将神经网络和符号推理融合的大语言模型框架

SymbolicAI是一个创新框架,融合大语言模型与任务特定提示,通过分治方法解决复杂问题。该框架实现可微分编程和经典编程的无缝集成,支持神经符号、语音、OCR和搜索等多种引擎。它为开发者提供交互式shell、聊天机器人和包管理工具,简化了基于LLM应用的开发和管理过程。

SymbolicAILLM神经符号Python框架Github开源项目

SymbolicAI

<img src="https://raw.githubusercontent.com/ExtensityAI/symbolicai/main/assets/images/symai_logo.png" width="200px">

A Neuro-Symbolic Perspective on Large Language Models (LLMs)

Building applications with LLMs at the core using our Symbolic API facilitates the integration of classical and differentiable programming in Python.

Read full paper here.

Read further documentation here.

PyPI version License Twitter Twitter contributions welcome Discord Hits GitHub forks GitHub stars

<img src="https://raw.githubusercontent.com/ExtensityAI/symbolicai/main/assets/images/preview.gif">

Abstract

Conceptually, SymbolicAI is a framework that leverages machine learning – specifically LLMs – as its foundation, and composes operations based on task-specific prompting. We adopt a divide-and-conquer approach to break down a complex problem into smaller, more manageable problems. Consequently, each operation addresses a simpler task. By reassembling these operations, we can resolve the complex problem. Moreover, our design principles enable us to transition seamlessly between differentiable and classical programming, allowing us to harness the power of both paradigms.

Tutorials

DateTitleVideo
2nd Dec. 2023Use ChatGPT and off-the-shelf RAG on Terminal/Command Prompt/ShellUse ChatGPT and off-the-shelf RAG on Terminal/Command Prompt/Shell
21st Nov. 2023Virtual Persona from Documents, Multi-Agent Chat, Text-to-Speech to hear your PersonasVirtual Persona from Documents, Multi-Agent Chat, Text-to-Speech to hear your Personas
1st Aug. 2023Automatic Retrieval Augmented Generation, Multimodal Inputs, User PackagesAutomatic Retrieval Augmented Generation, Multimodal Inputs, User Packages
22nd July 2023ChatBot In-Depth Demonstration (Tool Use and Iterative Processing)ChatBot In-Depth Demonstration (Tool Use and Iterative Processing)
1st July 2023Symbols, Operations, Expressions, LLM-based functions!Symbols, Operations, Expressions, LLM-based functions!
9th June 2023The future is neuro-symbolic: Expressiveness of ChatGPT and generalizability of symbolsThe future is neuro-symbolic: Expressiveness of ChatGPT and generalizability of symbols

📖 Table of Contents

🔧 Get Started

➡️ Quick Install

pip install symbolicai

One can run our framework in two ways:

API Keys

Before the first run, define exports for the required API keys to enable the respective engines. This will register the keys in internally for subsequent runs. By default SymbolicAI currently uses OpenAI's neural engines, i.e. GPT-3 Davinci-003, DALL·E 2 and Embedding Ada-002, for the neuro-symbolic computations, image generation and embeddings computation respectively. However, these modules can easily be replaced with open-source alternatives. Examples are

To set the OpenAI API Keys use the following command:

# Linux / MacOS export OPENAI_API_KEY="<OPENAI_API_KEY>" # Windows (PowerShell) $Env:OPENAI_API_KEY="<OPENAI_API_KEY>" # Jupyter Notebooks (important: do not use quotes) %env OPENAI_API_KEY=<OPENAI_API_KEY>

To get started import our library by using:

import symai as ai

Overall, the following engines are currently supported:

[Optional] Installs

SymbolicAI uses multiple engines to process text, speech and images. We also include search engine access to retrieve information from the web. To use all of them, you will need to install also the following dependencies or assign the API keys to the respective engines.

If you want to use the WolframAlpha Engine, Search Engine or OCR Engine you will need to export the following API keys:

# Linux / MacOS export SYMBOLIC_ENGINE_API_KEY="<WOLFRAMALPHA_API_KEY>" export SEARCH_ENGINE_API_KEY="<SERP_API_KEY>" export OCR_ENGINE_API_KEY="<APILAYER_API_KEY>" export INDEXING_ENGINE_API_KEY="<PINECONE_API_KEY>" # Windows (PowerShell) $Env:SYMBOLIC_ENGINE_API_KEY="<WOLFRAMALPHA_API_KEY>" $Env:SEARCH_ENGINE_API_KEY="<SERP_API_KEY>" $Env:OCR_ENGINE_API_KEY="<APILAYER_API_KEY>" $Env:INDEXING_ENGINE_API_KEY="<PINECONE_API_KEY>"

To use the optional engines, install the respective extras:

pip install "symbolicai[wolframalpha]" pip install "symbolicai[whisper]" pip install "symbolicai[selenium]" pip install "symbolicai[serpapi]" pip install "symbolicai[pinecone]"

Or, install all optional dependencies at once:

pip install "symbolicai[all]"

[Note] Additionally, you need to install the respective codecs.

  • SpeechToText Engine: ffmpeg for audio processing (based on OpenAI's whisper)
# Linux sudo apt update && sudo apt install ffmpeg # MacOS brew install ffmpeg # Windows choco install ffmpeg
  • WebCrawler Engine: For selenium, we automatically install the driver with chromedriver-autoinstaller. Currently we only support Chrome as the default browser.

Alternatively, you can specify in your project path a symai.config.json file with all the engine properties. This will replace the environment variables. See the following configuration file as an example:

{ "NEUROSYMBOLIC_ENGINE_API_KEY": "<OPENAI_API_KEY>", "NEUROSYMBOLIC_ENGINE_MODEL": "text-davinci-003", "SYMBOLIC_ENGINE_API_KEY": "<WOLFRAMALPHA_API_KEY>", "EMBEDDING_ENGINE_API_KEY": "<OPENAI_API_KEY>", "EMBEDDING_ENGINE_MODEL": "text-embedding-ada-002", "IMAGERENDERING_ENGINE_API_KEY": "<OPENAI_API_KEY>", "VISION_ENGINE_MODEL": "openai/clip-vit-base-patch32", "SEARCH_ENGINE_API_KEY": "<SERP_API_KEY>", "SEARCH_ENGINE_MODEL": "google", "OCR_ENGINE_API_KEY": "<APILAYER_API_KEY>", "SPEECH_TO_TEXT_ENGINE_MODEL": "base", "TEXT_TO_SPEECH_ENGINE_MODEL": "tts-1", "INDEXING_ENGINE_API_KEY": "<PINECONE_API_KEY>", "INDEXING_ENGINE_ENVIRONMENT": "us-west1-gcp", "COLLECTION_DB": "ExtensityAI", "COLLECTION_STORAGE": "SymbolicAI", "SUPPORT_COMMUNITY": False }

[NOTE]: Our framework allows you to support us train models for local usage by enabling the data collection feature. On application startup we show the terms of services and you can activate or disable this community feature. We do not share or sell your data to 3rd parties and only use the data for research purposes and to improve your user experience. To change this setting you will be prompted with in our setup wizard to enable or disable community support or you can go to the symai.config.json file located in your home directory of your .symai folder (i.e., ~/.symai/symai.config.json), and turn it on/off by setting the SUPPORT_COMMUNITY property to True/False via the config file or the respective environment variable. [NOTE]: By default, the user warnings are enabled. To disable them, export SYMAI_WARNINGS=0 in your environment variables.

🦖 Apps

We provide a set of useful tools that demonstrate how to interact with our framework and enable package manage. You can access these apps by calling the sym+<shortcut-name-of-app> command in your terminal or PowerShell.

Shell Command Tool

The Shell Command Tool is a basic shell command support tool that translates natural language commands into shell commands. To start the Shell Command Tool, simply run:

symsh

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多