Upload folder using huggingface_hub

.github/workflows/update_space.yml

@@ -0,0 +1,28 @@
+name: Run Python script
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Install Gradio
+      run: python -m pip install gradio
+
+    - name: Log in to Hugging Face
+      run: python -c 'import huggingface_hub; huggingface_hub.login(token="${{ secrets.hf_token }}")'
+
+    - name: Deploy to Spaces
+      run: gradio deploy

.gitignore

@@ -0,0 +1 @@
+.envx

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: double-quote-string-fixer
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: 'v2.0.2'
+    hooks:
+    -   id: autopep8
+-   repo: https://github.com/avilaton/add-msg-issue-prefix-hook
+    rev: v0.0.6  # Use the ref you want to point at
+    hooks:
+    -   id: add-msg-issue-prefix
+-   repo: https://github.com/PyCQA/autoflake
+    rev: v2.1.1
+    hooks:
+    -   id: autoflake
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)

README.md

@@ -1,12 +1,37 @@
 ---
 title: AustralianSlangChatbot
-emoji: 🐠
-colorFrom: gray
-colorTo: gray
+app_file: aussie_bot.py
 sdk: gradio
-sdk_version: 3.36.1
-app_file: app.py
-pinned: false
+sdk_version: 3.36.0
 ---
+# Australian Slang Chatbot
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+This is a chatbot that answers using Australian slang. The chatbot, named "Brissy," is powered by OpenAI's language model and can provide responses in a fair dinkum Aussie manner. It's designed to engage in conversations about Australia, Aussie culture, and a wide range of topics while incorporating friendly and authentic Australian slang.
+
+## Dependencies
+The following dependencies are required to run the chatbot:
+
+* gradio
+* openai
+* dotenv
+
+To install the dependencies, you can use the following command:
+
+```bash
+pip install gradio openai-python dotenv
+```
+Please ensure you have the appropriate access credentials for OpenAI's API by setting the `OPENAI_API_KEY` environment variable or using a `.env `file.
+
+## Usage
+To use the chatbot, follow these steps:
+
+1. Import the required modules and libraries.
+2. Set up the get_template() function, which returns the template for the chatbot's responses. It includes a placeholder for history and human input.
+3. Implement the get_chain() function, which returns the chatbot chain configuration using the LLMChain from the langchain library. This includes setting up the language model, prompt template, verbosity, and conversation memory.
+4. Define the interface() function, which launches the chatbot interface using the gradio library. It sets up the chatbot, message textbox, and clear button. It also includes the logic for user input and bot responses.
+5. Execute the interface() function to start the chatbot interface.
+
+## Notes
+1. The chatbot utilizes the OpenAI language model with a temperature setting of 0.5, which controls the randomness of the generated responses.
+2. The ConversationBufferWindowMemory is used to store and manage conversation history, with a buffer size of 100.
+3. The chatbot interface is created using the gradio library, providing an interactive and user-friendly experience.

aussie_bot.py

@@ -0,0 +1,85 @@
+"""
+A chatbot that will answer using australian slang
+"""
+import os
+import time
+
+import gradio as gr
+import openai
+from langchain import LLMChain, OpenAI, PromptTemplate
+from langchain.memory import ConversationBufferWindowMemory
+
+openai.api_key = os.getenv('OPENAI_API_KEY')
+
+
+def get_template() -> str:
+    """
+    Returns the template for the chatbot
+    """
+    template = """Brissy is a large language model trained by OpenAI.
+
+    Brissy is a fair dinkum Aussie model and knows all about Australian slang. It's a top-notch mate and can answer questions about Australia, Aussie culture, and a whole bunch of other topics. It always uses friendly slang and can chat like a true blue Aussie.
+
+    Reckon you can rewrite your response using Australian slang?
+
+    {history}
+    Human: {human_input}
+    Brissy:"""
+
+    return template
+
+
+def get_chain() -> LLMChain:
+    """
+    Returns the chatbot chain
+    """
+    template = get_template()
+
+    prompt = PromptTemplate(
+        input_variables=['history', 'human_input'],
+        template=template
+    )
+
+    chatgpt_chain = LLMChain(
+        llm=OpenAI(temperature=0.5),
+        prompt=prompt,
+        verbose=True,
+        memory=ConversationBufferWindowMemory(k=100),
+    )
+    return chatgpt_chain
+
+
+def interface() -> None:
+    """
+    Launches the chatbot interface.
+    """
+    with gr.Blocks() as demo:
+        chatbot = gr.Chatbot()
+        msg = gr.Textbox()
+        clear = gr.Button('Clear')
+        chatgpt_chain = get_chain()
+
+        def user(user_message, history):
+            return '', history + [[user_message, None]]
+
+        def bot(history):
+            human_input = history[-1][0]
+            response = chatgpt_chain.predict(human_input=human_input)
+
+            history[-1][1] = ''
+            for character in response:
+                history[-1][1] += character
+                time.sleep(0.01)
+                yield history
+
+        msg.submit(user, [msg, chatbot], [msg, chatbot], queue=False).then(
+            bot, chatbot, chatbot
+        )
+        clear.click(lambda: None, None, chatbot, queue=False)
+
+    demo.queue()
+    demo.launch()
+
+
+if __name__ == '__main__':
+    interface()

requirements.txt

@@ -0,0 +1,6 @@
+gradio==3.36.0
+gradio_client==0.2.7
+langchain==0.0.228
+langchainplus-sdk==0.0.20
+openai==0.27.8
+python-dotenv==1.0.0