Fully support conversational-chatting

Author: Simatwa

docs/CHANGELOG.md

@@ -56,3 +56,8 @@
 
 **What's new?**
 - Chatting conversationally - **Stable**
+
+## v0.1.0
+
+**What's new?**
+- Chatting conversationally - **Default Mode**

docs/README.md

@@ -5,7 +5,7 @@
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml"><img src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml/badge.svg" alt="Python Test"/></a>
 -->
 <a href="https://github.com/Simatwa/python-tgpt/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/static/v1?logo=GPL&color=Blue&message=MIT&label=License"/></a>
-<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=v0.0.9&color=green"/></a>
+<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=v0.1.0&color=green"/></a>
 <a href="https://github.com/psf/black"><img alt="Black" src="https://img.shields.io/static/v1?logo=Black&label=Code-style&message=Black"/></a>
 <a href="#"><img alt="Passing" src="https://img.shields.io/static/v1?logo=Docs&label=Docs&message=Passing&color=green"/></a>
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml"><img src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml/badge.svg"/></a>
@@ -41,6 +41,16 @@ This project enables seamless interaction with [LLaMA](https://ai.meta.com/llama
 
 The name *python-tgpt* draws inspiration from its parent project [tgpt](https://github.com/aandrew-me/tgpt), which operates on [golang](https://go.dev/). Through this Python adaptation, users can effortlessly engage with LLaMA's capabilities, fostering a smoother AI interaction experience.
 
+## Features
+
+- 🗨️ Enhanced conversational chat experience
+- 💾 Capability to save prompts and responses (Conversation)
+- 🔄 Ability to load previous conversations
+- ⌨️ Command-line interface
+- 🐍 Python package
+- 🌊 Stream and non-stream response
+- 🚀 Ready to use (No API key required)
+
 ## Prerequisites
 
 - [x] [Python>=3.9](https://python.org)
@@ -168,7 +178,7 @@ for value in resp:
 
 <summary>
 
-- To get better feedback, you can make use of [optimizers](tgpt/utils.py) using parameter `optimizer` with values *(code or system_command)*
+To obtain more tailored responses, consider utilizing [optimizers](tgpt/utils.py) using the `optimizer` parameter. Its values can be set to either `code` or `system_command`.
 
 </summary>
 
@@ -181,17 +191,15 @@ print(resp)
 
 </details>
 
+**Note**: Commencing from [v0.1.0](https://github.com/Simatwa/python-tgpt/releases/), the default mode of interaction is conversational. This mode enhances the interactive experience, offering better control over the chat history. By associating previous prompts and responses, it tailors conversations for a more engaging experience.
 
-
-**Note**: Starting from [v0.0.7](https://github.com/Simatwa/python-tgpt/releases/), we've introduced an experimental conversational chatting feature:
+You can still disable the mode:
 
 ```python
-bot = tgpt.TGPT(is_conversation=True)
+bot = tgpt.TGPT(is_conversation=False)
 ```
 
-When interacting via the console, simply append the `--conversation` flag. Customize the `history_offset` parameter during the initialization of `TGPT` and utilize the `--history-offset` flag at the console entry point for the same.
-
-This conversational mode opens up a more interactive and engaging experience, allowing greater control over the chat history's handling for a more tailored conversation.
+Utilize the `--disable-conversation` flag in the console to achieve the same functionality.
 
 
 ## Acknowledgements

requirements.txt

@@ -12,7 +12,7 @@
 
 setup(
     name="python-tgpt",
-    version="0.0.9",
+    version="0.1.0",
     license="MIT",
     author="Smartwa",
     maintainer="Smartwa",
@@ -39,7 +39,7 @@
         "rich==13.3.4",
         "clipman==3.1.0",
         "pyperclip==1.8.2",
-        "appdirs==1.4.4"
+        "appdirs==1.4.4",
     ],
     python_requires=">=3.9",
     keywords=[

setup.py

@@ -0,0 +1,3 @@
+from tgpt import Imager
+
+# Not working currently

tests/test_imager.py

@@ -1,7 +1,7 @@
 from .tgpt import TGPT
 from .imager import Imager
 
-__version__ = "0.0.9"
+__version__ = "0.1.0"
 __author__ = "Smartwa"
 __repo__ = "https://github.com/Simatwa/python-tgpt"
 

tgpt/__init__.py

@@ -21,6 +21,7 @@
 from rich.prompt import Prompt
 from typing import Iterator
 from tgpt.utils import Optimizers
+from tgpt.utils import default_path
 
 getExc = lambda e: e.args[1] if len(e.args) > 1 else str(e)
 
@@ -177,7 +178,7 @@ def __init__(
         model,
         brave_key,
         timeout,
-        conversation,
+        disable_conversation,
         filepath,
         update_file,
         intro,
@@ -196,7 +197,7 @@ def __init__(
             proxies = {}
         try:
             self.bot = tgpt.TGPT(
-                conversation,
+                disable_conversation,
                 max_tokens,
                 temperature,
                 top_k,
@@ -564,16 +565,17 @@ def tgpt2_():
     "--prettify/--raw", help="Flag for prettifying markdowned response", default=True
 )
 @click.option(
-    "-C",
-    "--conversation",
+    "-dc",
+    "--disable-conversation",
     is_flag=True,
-    default=False,
-    help="Chat conversationally (Experimental)",
+    default=True,  # is_conversation = True
+    help="Disable chatting conversationally (Stable)",
 )
 @click.option(
     "-fp",
     "--filepath",
     type=click.Path(),
+    default=os.path.join(default_path, "chat-history.txt"),
     help="Path to chat history - new will be created incase doesn't exist",
 )
 @click.option(
@@ -628,7 +630,7 @@ def interactive(
     timeout,
     prompt,
     prettify,
-    conversation,
+    disable_conversation,
     filepath,
     update_file,
     intro,
@@ -667,7 +669,7 @@ def timeout_handler(signum, frame):
         model,
         brave_key,
         timeout,
-        conversation,
+        disable_conversation,
         filepath,
         update_file,
         intro,
@@ -772,16 +774,17 @@ def timeout_handler(signum, frame):
     help="Optimize prompt for shell command generation",
 )
 @click.option(
-    "-C",
-    "--conversation",
+    "-dc",
+    "--disable-conversation",
     is_flag=True,
-    default=False,
-    help="Chat conversationally (Experimental)",
+    default=True,  # is_conversation = True
+    help="Disable chatting conversationally (Stable)",
 )
 @click.option(
     "-fp",
     "--filepath",
     type=click.Path(),
+    default=os.path.join(default_path, "chat-history.txt"),
     help="Path to chat history - new will be created incase doesn't exist",
 )
 @click.option(
@@ -839,7 +842,7 @@ def generate(
     whole,
     code,
     shell,
-    conversation,
+    disable_conversation,
     filepath,
     update_file,
     intro,
@@ -857,7 +860,7 @@ def generate(
         model,
         brave_key,
         timeout,
-        conversation,
+        disable_conversation,
         filepath,
         update_file,
         intro,

tgpt/console.py

@@ -10,7 +10,7 @@
 class TGPT:
     def __init__(
         self,
-        is_conversation: bool = False,
+        is_conversation: bool = True,
         max_tokens: int = 600,
         temperature: float = 0.2,
         top_k: int = -1,
@@ -28,7 +28,7 @@ def __init__(
         """Instantiate TGPT
 
         Args:
-            conversationally (str, optional): Flag for chatting conversationally. Defaults to False.
+            is_conversation (str, optional): Flag for chatting conversationally. Defaults to True.
             brave_key (str, optional): Brave API access key. Defaults to "qztbjzBqJueQZLFkwTTJrieu8Vw3789u".
             model (str, optional): Text generation model name. Defaults to "llama-2-13b-chat".
             max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.

tgpt/tgpt.py

@@ -150,6 +150,8 @@ def update_chat_history(self, prompt: str, response: str) -> None:
             prompt (str): user prompt
             response (str): LLM response
         """
+        if not self.status:
+            return
         new_history = self.history_format % dict(user=prompt, llm=response)
         if self.file and self.update_file:
             with open(self.file, "a") as fh: