📝 XS Module Documentation

The workflow of the XS module, with a tagline : xs makes you access

This module leverages Flask, Pyngrok, and Waitress to create a simple API endpoint for text generation of all Open Source LLMs.

🚀 Features

• 🌐 API Endpoint Creation: Easily create an API endpoint to access the text generation function.
• 🔀 Dynamic Port Allocation: Automatically find an available port to avoid conflicts.
• 🚧 Ngrok Tunneling: Expose your local server to the internet using Ngrok.
• 🔄 Flushing Tunnels: Clear previous Ngrok tunnels to avoid the max tunnel limit.

📦 Installation

To use this module, you need to install by the following command :

pip install 'git+https://github.com/xprabhudayal/xs.git'

📋 Tutorials and Usage

1 Watch these videos for better Understanding

2. Finding an Available Port

xs.find_port()

It dynamically finds an available port.

3. Forward Function

xs.forward(NGROK_API)

The xs.forward() function sets up the Ngrok tunnel and starts the server using Waitress. NGROK_API is required here.

4. Connect Text Function

xs.connect_text(url, prompt)

The connect_text function allows remote devices to access the API and use the text generation option. It sends a POST request to the API endpoint with the provided data and prints the generated text response.

5. Flushing Tunnels

xs.flush()

The flush function clears all previous Ngrok tunnels. In the free tier, you can have 3 tunnels only! This is useful if you encounter the maximum tunnel limit error from Ngrok.

🔧 Future Features

• Port Killing: Automatically kill processes using specific ports before starting the server.
• Enhanced Error Handling: Improve the robustness of error handling mechanisms.

🛠 Troubleshooting

• Ngrok Tunnel Error: If you encounter a max tunnel limit, use the flush function to clear previous tunnels.
• JSON Decode Error: Ensure the API response is correctly formatted JSON.

License 📄

This project is licensed under the MIT License.

Contact 📧

For any inquiries, please reach me at : MAIL

Made with 💖 by Prabhudayal

Enjoy using the xs.py module! 🚀