textxgen 0.1.5

A Python package for interacting with models

TextxGen

TextxGen is a Python package that provides a seamless interface to interact with Large Language models . It supports chat-based conversations and text completions using predefined models. The package is designed to be simple, modular, and easy to use, making it ideal for developers who want to integrate llm models into their applications.

---

Features

• Predefined API Key: No need to provide your own API key—TextxGen uses a predefined key internally.
• Supported Models: Access popular models like:
  • meta-llama/llama-3.1-8b-instruct
  • microsoft/phi-3-mini-128k-instruct
  • deepseek/deepseek-chat
• Chat and Completions: Supports both chat-based conversations and text completions.
• System Prompts: Add system-level prompts to guide model interactions.
• Error Handling: Robust exception handling for API failures, invalid inputs, and network issues.
• Modular Design: Easily extendable to support additional models in the future.

---

Installation

You can install TextxGen in one of two ways:

Option 1: Install via pip

pip install textxgen

Option 2: Clone the Repository

1. Clone the repository from GitHub:

   git clone https://github.com/Sohail-Shaikh-07/textxgen.git
   

2. Navigate to the project directory:

   cd textxgen
   

3. Install the package locally:

   pip install .
   

---

Usage

1. Chat Example

Use the ChatEndpoint to interact with chat-based models.

from textxgen import ChatEndpoint

def main():
    # Initialize the ChatEndpoint
    chat = ChatEndpoint()

    # Define the conversation messages
    messages = [
        {"role": "user", "content": "What is the capital of France?"},
    ]

    # Add a system prompt (optional)
    system_prompt = "You are a helpful assistant."

    # Send the chat request
    response = chat.chat(
        messages=messages,
        model="llama3",  # Use the LLaMA 3 model
        system_prompt=system_prompt,
        temperature=0.7,  # Adjust creativity
        max_tokens=100,   # Limit response length
    )

    # Format and print the response
    print("=== Chat Response ===")
    print(response["choices"][0]["message"]["content"])

if __name__ == "__main__":
    main()

Output:

=== Chat Response ===
The capital of France is Paris.

---

2. Completions Example

Use the CompletionsEndpoint to generate text completions.

from textxgen import CompletionsEndpoint

def main():
    # Initialize the CompletionsEndpoint
    completions = CompletionsEndpoint()

    # Define the input prompt
    prompt = "Once upon a time"

    # Send the completion request
    response = completions.complete(
        prompt=prompt,
        model="phi3",      # Use the Phi-3 model
        temperature=0.7,   # Adjust creativity
        max_tokens=100,    # Limit response length
    )

    # Format and print the response
    print("=== Completion Response ===")
    print(response["choices"][0]["text"])

if __name__ == "__main__":
    main()

Output:

=== Completion Response ===
Once upon a time, in a land far, far away...

---

3. Listing Supported Models

Use the ModelsEndpoint to list and retrieve supported models.

from textxgen import ModelsEndpoint

def main():
    """
    Example usage of the ModelsEndpoint to list and retrieve supported models.
    """
    # Initialize the ModelsEndpoint
    models = ModelsEndpoint()

    # List all supported models
    print("=== Supported Models ===")
    for model_name, display_name in models.list_display_models().items():
        print(f"{model_name}: {display_name}")


if __name__ == "__main__":
    main()

Output:

=== Supported Models ===
llama3: LLaMA 3 (8B Instruct)
phi3: Phi-3 Mini (128K Instruct)
deepseek: DeepSeek Chat

4. Streaming Example

You can enable streaming for real-time responses by setting stream=True.

Chat Streaming Example

from textxgen import ChatEndpoint

# Initialize the ChatEndpoint
chat = ChatEndpoint()

# Define the conversation messages
messages = [
    {"role": "user", "content": "What is the capital of France?"},
]

# Add a system prompt (optional)
system_prompt = "You are a helpful assistant."

# Send the chat request with streaming
print("=== Chat Response (Streaming) ===")
response_stream = chat.chat(
    messages=messages,
    model="llama3",
    system_prompt=system_prompt,
    temperature=0.7,
    max_tokens=100,
    stream=True,  # Enable streaming
)

# Process the streaming response
for chunk in response_stream:
    if "choices" in chunk and len(chunk["choices"]) > 0:
        content = chunk["choices"][0].get("delta", {}).get("content", "")
        if content:
            print(content, end="", flush=True)

print("\n")

Output:

The capital of France is Paris.

Chat Completion Example

from textxgen import CompletionsEndpoint

# Initialize the CompletionsEndpoint
completions = CompletionsEndpoint()

# Define the input prompt
prompt = "Once upon a time"

# Send the completion request with streaming
print("=== Completion Response (Streaming) ===")
response_stream = completions.complete(
    prompt=prompt,
    model="phi3",
    temperature=0.7,
    max_tokens=100,
    stream=True,  # Enable streaming
)

# Process the streaming response
for chunk in response_stream:
    if "choices" in chunk and len(chunk["choices"]) > 0:
        # Extract the generated text from the response
        text = chunk["choices"][0].get("text", "")
        if text:
            print(text, end="", flush=True)

print("\n")

Output:

Once upon a time, in a land far, far away...

---

Supported Models

TextxGen currently supports the following models:

Model Name	Model ID	Description
LLaMA 3 (8B Instruct)	llama3	A powerful 8-billion parameter model for general-purpose tasks.
Phi-3 Mini (128K Instruct)	phi3	A lightweight yet capable model optimized for efficiency.
DeepSeek Chat	deepseek	A conversational model designed for interactive chat.

---

Error Handling

TextxGen provides robust error handling for common issues:

• Invalid Input: Raised when invalid input is provided (e.g., empty messages or prompts).
• API Errors: Raised when the API returns an error (e.g., network issues or invalid requests).
• Unsupported Models: Raised when an unsupported model is requested.

Example:

from textxgen.exceptions import InvalidInputError

try:
    response = chat.chat(messages=[])
except InvalidInputError as e:
    print("Error:", str(e))

---

Contributing

Contributions are welcome! To contribute to TextxGen:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Submit a pull request with a detailed description of your changes.

---

License

TextxGen is licensed under the MIT License. See the LICENSE file for details.

---

Support

If you encounter any issues or have questions, please open an issue on the GitHub repository.