feat: :sparkles: Support Hugging Face (#12)

README.md

@@ -1,3 +1,16 @@
+---
+title: Edu Assistant
+emoji: 🐠
+colorFrom: pink
+colorTo: blue
+sdk: gradio
+sdk_version: 3.37.0
+app_file: webui/ui.py
+fullWidth: true
+pinned: false
+license: mit
+---
+
 # Edu Assistant
 
 [![Checkstyle](https://github.com/Arcadia822/codedog/actions/workflows/flake8.yml/badge.svg)](https://github.com/codedog-ai/edu-assistant/actions/workflows/flake8.yml)

edu_assistant/learning_tasks/qa.py

@@ -122,7 +122,9 @@ class QaTask(BaseTask):
         if not self._knowledge:
             return ConversationChain(
                 llm=load_llm(),
-                memory=ConversationBufferMemory(memory_key=QaTask.HISTORY_KEY, output_key=self._output_key),
+                memory=ConversationBufferMemory(
+                    memory_key=QaTask.HISTORY_KEY, output_key=self._output_key, return_messages=True
+                ),
                 prompt=self._chat_prompt,
             )
         else:
@@ -132,7 +134,9 @@ class QaTask(BaseTask):
                 condense_question_llm=load_llm(),
                 return_source_documents=True,
                 combine_docs_chain_kwargs={"prompt": self._chat_prompt},
-                memory=ConversationBufferMemory(memory_key=QaTask.HISTORY_KEY, output_key=self._output_key),
+                memory=ConversationBufferMemory(
+                    memory_key=QaTask.HISTORY_KEY, output_key=self._output_key, return_messages=True
+                ),
             )
 
     def ask(

examples/qa.py

@@ -1,6 +1,8 @@
 import json
 import logging
 
+from fastapi.encoders import jsonable_encoder
+
 from edu_assistant.learning_tasks import QaTask
 from edu_assistant.utils.common_utils import init_local_logging
 
@@ -15,14 +17,14 @@ task = QaTask(instruction=instruction)
 
 def qa_once():
     result = task.ask("请问什么是指针？", session=False)
-    print(json.dumps(result, ensure_ascii=False, indent=4))
+    print(json.dumps(jsonable_encoder(result), ensure_ascii=False, indent=4))
 
 
 def qa_twice():
     task = QaTask()
     result = task.ask("请问如何释放一个数组？")
     result = task.ask("那指针呢？", session_id=result["session_id"])
-    print(json.dumps(result, ensure_ascii=False, indent=4))
+    print(json.dumps(jsonable_encoder(result), ensure_ascii=False, indent=4))
 
 
 if __name__ == "__main__":

examples/qdrant_vs.py

@@ -33,7 +33,7 @@ def add_docs(path: str, collection_name: str):
     vs = load_vectorstore(collection_name=collection_name)
     loader = DirectoryLoader(path=path, glob="*.txt", loader_cls=TextLoader)
     documents = loader.load()
-    text_splitter = CharacterTextSplitter(chunk_size=500, chunk_overlap=0)
+    text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=50)
     docs = text_splitter.split_documents(documents)
 
     for doc in docs:
@@ -43,7 +43,7 @@ def add_docs(path: str, collection_name: str):
 def qa(collection_name: str, question: str):
     chain = RetrievalQA.from_llm(
         llm=load_llm(),
-        retriever=load_vectorstore(collection_name=collection_name).as_retriever(),
+        retriever=load_vectorstore(collection_name=collection_name).as_retriever(k=1),
         return_source_documents=True,
     )
     result = chain(question)
@@ -53,9 +53,9 @@ def qa(collection_name: str, question: str):
 if __name__ == "__main__":
     name = "example"
     path = "examples/docs"
-    question = "C和C++的区别是什么？"
+    question = "C++有哪些数据类型修饰符？"
 
-    create_collection(name)
-    add_docs(path, name)
+    # delete_collection(name)
+    # create_collection(name)
+    # add_docs(path, name)
     qa(name, question)
-    delete_collection(name)

requirements.txt

@@ -0,0 +1,96 @@
+--trusted-host mirrors.aliyun.com
+--extra-index-url http://mirrors.aliyun.com/pypi/simple
+
+aiofiles==23.1.0 ; python_version >= "3.10" and python_version < "3.12"
+aiohttp==3.8.4 ; python_version >= "3.10" and python_version < "3.12"
+aiosignal==1.3.1 ; python_version >= "3.10" and python_version < "3.12"
+altair==5.0.1 ; python_version >= "3.10" and python_version < "3.12"
+anyio==3.7.1 ; python_version >= "3.10" and python_version < "3.12"
+async-timeout==4.0.2 ; python_version >= "3.10" and python_version < "3.12"
+attrs==23.1.0 ; python_version >= "3.10" and python_version < "3.12"
+certifi==2023.5.7 ; python_version >= "3.10" and python_version < "3.12"
+charset-normalizer==3.2.0 ; python_version >= "3.10" and python_version < "3.12"
+click==8.1.5 ; python_version >= "3.10" and python_version < "3.12"
+colorama==0.4.6 ; python_version >= "3.10" and python_version < "3.12" and platform_system == "Windows"
+contourpy==1.1.0 ; python_version >= "3.10" and python_version < "3.12"
+cycler==0.11.0 ; python_version >= "3.10" and python_version < "3.12"
+dataclasses-json==0.5.9 ; python_version >= "3.10" and python_version < "3.12"
+exceptiongroup==1.1.2 ; python_version >= "3.10" and python_version < "3.11"
+fastapi==0.95.2 ; python_version >= "3.10" and python_version < "3.12"
+ffmpy==0.3.1 ; python_version >= "3.10" and python_version < "3.12"
+filelock==3.12.2 ; python_version >= "3.10" and python_version < "3.12"
+fonttools==4.41.0 ; python_version >= "3.10" and python_version < "3.12"
+frozenlist==1.4.0 ; python_version >= "3.10" and python_version < "3.12"
+fsspec==2023.6.0 ; python_version >= "3.10" and python_version < "3.12"
+gradio-client==0.2.10 ; python_version >= "3.10" and python_version < "3.12"
+gradio==3.37.0 ; python_version >= "3.10" and python_version < "3.12"
+greenlet==2.0.2 ; python_version >= "3.10" and python_version < "3.12" and (platform_machine == "win32" or platform_machine == "WIN32" or platform_machine == "AMD64" or platform_machine == "amd64" or platform_machine == "x86_64" or platform_machine == "ppc64le" or platform_machine == "aarch64")
+grpcio-tools==1.56.0 ; python_version >= "3.10" and python_version < "3.12"
+grpcio==1.56.0 ; python_version >= "3.10" and python_version < "3.12"
+h11==0.14.0 ; python_version >= "3.10" and python_version < "3.12"
+h2==4.1.0 ; python_version >= "3.10" and python_version < "3.12"
+hpack==4.0.0 ; python_version >= "3.10" and python_version < "3.12"
+httpcore==0.17.3 ; python_version >= "3.10" and python_version < "3.12"
+httpx==0.24.1 ; python_version >= "3.10" and python_version < "3.12"
+httpx[http2]==0.24.1 ; python_version >= "3.10" and python_version < "3.12"
+huggingface-hub==0.16.4 ; python_version >= "3.10" and python_version < "3.12"
+hyperframe==6.0.1 ; python_version >= "3.10" and python_version < "3.12"
+idna==3.4 ; python_version >= "3.10" and python_version < "3.12"
+jinja2==3.1.2 ; python_version >= "3.10" and python_version < "3.12"
+jsonschema-specifications==2023.6.1 ; python_version >= "3.10" and python_version < "3.12"
+jsonschema==4.18.3 ; python_version >= "3.10" and python_version < "3.12"
+kiwisolver==1.4.4 ; python_version >= "3.10" and python_version < "3.12"
+langchain==0.0.234 ; python_version >= "3.10" and python_version < "3.12"
+langsmith==0.0.5 ; python_version >= "3.10" and python_version < "3.12"
+linkify-it-py==2.0.2 ; python_version >= "3.10" and python_version < "3.12"
+markdown-it-py==2.2.0 ; python_version >= "3.10" and python_version < "3.12"
+markdown-it-py[linkify]==2.2.0 ; python_version >= "3.10" and python_version < "3.12"
+markupsafe==2.1.3 ; python_version >= "3.10" and python_version < "3.12"
+marshmallow-enum==1.5.1 ; python_version >= "3.10" and python_version < "3.12"
+marshmallow==3.19.0 ; python_version >= "3.10" and python_version < "3.12"
+matplotlib==3.7.2 ; python_version >= "3.10" and python_version < "3.12"
+mdit-py-plugins==0.3.3 ; python_version >= "3.10" and python_version < "3.12"
+mdurl==0.1.2 ; python_version >= "3.10" and python_version < "3.12"
+multidict==6.0.4 ; python_version >= "3.10" and python_version < "3.12"
+mypy-extensions==1.0.0 ; python_version >= "3.10" and python_version < "3.12"
+numexpr==2.8.4 ; python_version >= "3.10" and python_version < "3.12"
+numpy==1.25.1 ; python_version >= "3.10" and python_version < "3.12"
+openai==0.27.8 ; python_version >= "3.10" and python_version < "3.12"
+openapi-schema-pydantic==1.2.4 ; python_version >= "3.10" and python_version < "3.12"
+orjson==3.9.2 ; python_version >= "3.10" and python_version < "3.12"
+packaging==23.1 ; python_version >= "3.10" and python_version < "3.12"
+pandas==2.0.3 ; python_version >= "3.10" and python_version < "3.12"
+pillow==10.0.0 ; python_version >= "3.10" and python_version < "3.12"
+portalocker==2.7.0 ; python_version >= "3.10" and python_version < "3.12"
+protobuf==4.23.4 ; python_version >= "3.10" and python_version < "3.12"
+pydantic==1.10.11 ; python_version >= "3.10" and python_version < "3.12"
+pydub==0.25.1 ; python_version >= "3.10" and python_version < "3.12"
+pyparsing==3.0.9 ; python_version >= "3.10" and python_version < "3.12"
+python-dateutil==2.8.2 ; python_version >= "3.10" and python_version < "3.12"
+python-multipart==0.0.6 ; python_version >= "3.10" and python_version < "3.12"
+pytz==2023.3 ; python_version >= "3.10" and python_version < "3.12"
+pywin32==306 ; python_version >= "3.10" and python_version < "3.12" and platform_system == "Windows"
+pyyaml==6.0 ; python_version >= "3.10" and python_version < "3.12"
+qdrant-client==1.3.1 ; python_version >= "3.10" and python_version < "3.12"
+referencing==0.29.1 ; python_version >= "3.10" and python_version < "3.12"
+regex==2023.6.3 ; python_version >= "3.10" and python_version < "3.12"
+requests==2.31.0 ; python_version >= "3.10" and python_version < "3.12"
+rpds-py==0.8.11 ; python_version >= "3.10" and python_version < "3.12"
+semantic-version==2.10.0 ; python_version >= "3.10" and python_version < "3.12"
+setuptools==68.0.0 ; python_version >= "3.10" and python_version < "3.12"
+six==1.16.0 ; python_version >= "3.10" and python_version < "3.12"
+sniffio==1.3.0 ; python_version >= "3.10" and python_version < "3.12"
+sqlalchemy==2.0.18 ; python_version >= "3.10" and python_version < "3.12"
+starlette==0.27.0 ; python_version >= "3.10" and python_version < "3.12"
+tenacity==8.2.2 ; python_version >= "3.10" and python_version < "3.12"
+tiktoken==0.4.0 ; python_version >= "3.10" and python_version < "3.12"
+toolz==0.12.0 ; python_version >= "3.10" and python_version < "3.12"
+tqdm==4.65.0 ; python_version >= "3.10" and python_version < "3.12"
+typing-extensions==4.5.0 ; python_version >= "3.10" and python_version < "3.12"
+typing-inspect==0.9.0 ; python_version >= "3.10" and python_version < "3.12"
+tzdata==2023.3 ; python_version >= "3.10" and python_version < "3.12"
+uc-micro-py==1.0.2 ; python_version >= "3.10" and python_version < "3.12"
+urllib3==1.26.16 ; python_version >= "3.10" and python_version < "3.12"
+uvicorn==0.21.1 ; python_version >= "3.10" and python_version < "3.12"
+websockets==11.0.3 ; python_version >= "3.10" and python_version < "3.12"
+yarl==1.9.2 ; python_version >= "3.10" and python_version < "3.12"

webui/qa.py

@@ -59,5 +59,5 @@ with gr.Blocks() as qa_ui:
         with gr.Column(scale=1):
             apply = gr.Button(value="更换Prompt")
 
-    msg.submit(respond, [msg, chatbot, session_id], [msg, chatbot, session_id, telemetry])
+    msg.submit(respond, [msg, chatbot, session_id], [msg, chatbot, session_id, telemetry, docs])
     apply.click(recreate, [instruction], [])