webscout 3.6__tar.gz → 3.7__tar.gz

{webscout-3.6/webscout.egg-info → webscout-3.7}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 3.6
-Summary: Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
+Version: 3.7
+Summary: Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs and more
 Author: OEvortex
 Author-email: helpingai5@gmail.com
 License: HelpingAI
@@ -62,7 +62,7 @@ Provides-Extra: local
 Requires-Dist: llama-cpp-python; extra == "local"
 Requires-Dist: colorama; extra == "local"
 Requires-Dist: numpy; extra == "local"
-Requires-Dist: huggingface_hub; extra == "local"
+Requires-Dist: huggingface_hub[cli]; extra == "local"
 
 <div align="center">
   <!-- Replace `#` with your actual links -->
@@ -1447,13 +1447,19 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
-### `Local-LLM` webscout can now run GGUF models
-Local LLM's some functions are taken from easy-llama
+
+##  Local-LLM
+
+Webscout can now run GGUF models locally. You can download and run your favorite models with minimal configuration.
+
+**Example:**
+
 ```python
 from webscout.Local.utils import download_model
 from webscout.Local.model import Model
 from webscout.Local.thread import Thread
 from webscout.Local import formats
+
 # 1. Download the model
 repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
 filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
@@ -1469,7 +1475,11 @@ thread = Thread(model, formats.phi3)
 thread.interact()
 ```
 
-### `Local-rawdog`
+## Local-rawdog
+Webscout's local raw-dog feature allows you to run Python scripts within your terminal prompt.
+
+**Example:**
+
 ```python
 import webscout.Local as ws
 from webscout.Local.rawdog import RawDog
@@ -1556,6 +1566,63 @@ while True:
         print(script_output)
 
 ```
+
+##  GGUF 
+
+Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for use with offline LLMs.
+
+**Example:**
+
+```python
+from webscout import gguf
+"""
+Valid quantization methods:
+"q2_k", "q3_k_l", "q3_k_m", "q3_k_s", 
+"q4_0", "q4_1", "q4_k_m", "q4_k_s", 
+"q5_0", "q5_1", "q5_k_m", "q5_k_s", 
+"q6_k", "q8_0"
+"""
+gguf.convert(
+    model_id="OEvortex/HelpingAI-Lite-1.5T",  # Replace with your model ID
+    username="Abhaykoul",  # Replace with your Hugging Face username
+    token="hf_token_write",  # Replace with your Hugging Face token
+    quantization_methods="q4_k_m"  # Optional, adjust quantization methods
+)
+```
+
+## Autollama
+
+Webscout's `autollama` utility download model from huggingface and then automatically makes it ollama ready
+
+**Example:**
+
+```python
+from webscout import autollama
+
+autollama.autollama(
+    model_path="OEvortex/HelpingAI-Lite-1.5T",  # Hugging Face model ID
+    gguf_file="HelpingAI-Lite-1.5T.q4_k_m.gguf" #  GGUF file ID
+)
+```
+
+**Command Line Usage:**
+
+* **GGUF Conversion:**
+   ```bash
+   python -m webscout.Extra.gguf -m "OEvortex/HelpingAI-Lite-1.5T" -u "your_username" -t "your_hf_token" -q "q4_k_m,q5_k_m" 
+   ```
+
+* **Autollama:**
+   ```bash
+   python -m webscout.Extra.autollama -m "OEvortex/HelpingAI-Lite-1.5T" -g "HelpingAI-Lite-1.5T.q4_k_m.gguf" 
+   ```
+
+**Note:** 
+
+* Replace `"your_username"` and `"your_hf_token"` with your actual Hugging Face credentials.
+* The `model_path` in `autollama` is the Hugging Face model ID, and `gguf_file` is the GGUF file ID.
+
+
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-3.6 → webscout-3.7}/README.md

@@ -1381,13 +1381,19 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
-### `Local-LLM` webscout can now run GGUF models
-Local LLM's some functions are taken from easy-llama
+
+##  Local-LLM
+
+Webscout can now run GGUF models locally. You can download and run your favorite models with minimal configuration.
+
+**Example:**
+
 ```python
 from webscout.Local.utils import download_model
 from webscout.Local.model import Model
 from webscout.Local.thread import Thread
 from webscout.Local import formats
+
 # 1. Download the model
 repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
 filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
@@ -1403,7 +1409,11 @@ thread = Thread(model, formats.phi3)
 thread.interact()
 ```
 
-### `Local-rawdog`
+## Local-rawdog
+Webscout's local raw-dog feature allows you to run Python scripts within your terminal prompt.
+
+**Example:**
+
 ```python
 import webscout.Local as ws
 from webscout.Local.rawdog import RawDog
@@ -1490,6 +1500,63 @@ while True:
         print(script_output)
 
 ```
+
+##  GGUF 
+
+Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for use with offline LLMs.
+
+**Example:**
+
+```python
+from webscout import gguf
+"""
+Valid quantization methods:
+"q2_k", "q3_k_l", "q3_k_m", "q3_k_s", 
+"q4_0", "q4_1", "q4_k_m", "q4_k_s", 
+"q5_0", "q5_1", "q5_k_m", "q5_k_s", 
+"q6_k", "q8_0"
+"""
+gguf.convert(
+    model_id="OEvortex/HelpingAI-Lite-1.5T",  # Replace with your model ID
+    username="Abhaykoul",  # Replace with your Hugging Face username
+    token="hf_token_write",  # Replace with your Hugging Face token
+    quantization_methods="q4_k_m"  # Optional, adjust quantization methods
+)
+```
+
+## Autollama
+
+Webscout's `autollama` utility download model from huggingface and then automatically makes it ollama ready
+
+**Example:**
+
+```python
+from webscout import autollama
+
+autollama.autollama(
+    model_path="OEvortex/HelpingAI-Lite-1.5T",  # Hugging Face model ID
+    gguf_file="HelpingAI-Lite-1.5T.q4_k_m.gguf" #  GGUF file ID
+)
+```
+
+**Command Line Usage:**
+
+* **GGUF Conversion:**
+   ```bash
+   python -m webscout.Extra.gguf -m "OEvortex/HelpingAI-Lite-1.5T" -u "your_username" -t "your_hf_token" -q "q4_k_m,q5_k_m" 
+   ```
+
+* **Autollama:**
+   ```bash
+   python -m webscout.Extra.autollama -m "OEvortex/HelpingAI-Lite-1.5T" -g "HelpingAI-Lite-1.5T.q4_k_m.gguf" 
+   ```
+
+**Note:** 
+
+* Replace `"your_username"` and `"your_hf_token"` with your actual Hugging Face credentials.
+* The `model_path` in `autollama` is the Hugging Face model ID, and `gguf_file` is the GGUF file ID.
+
+
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-3.6 → webscout-3.7}/setup.py

@@ -5,8 +5,8 @@ with open("README.md", encoding="utf-8") as f:
 
 setup(
     name="webscout",
-    version="3.6",
-    description="Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs",
+    version="3.7",
+    description="Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs and more",
     long_description=README,
     long_description_content_type="text/markdown",
     author="OEvortex",
@@ -75,7 +75,7 @@ setup(
             'llama-cpp-python',
             'colorama',
             'numpy',
-            'huggingface_hub',
+            'huggingface_hub[cli]',
         ],
     },
     license="HelpingAI",

webscout-3.7/webscout/Extra/__init__.py

@@ -0,0 +1,2 @@
+from .gguf import *
+from .autollama import *

webscout-3.7/webscout/Extra/autollama.py

@@ -0,0 +1,47 @@
+import subprocess
+import argparse
+import os
+
+def autollama(model_path, gguf_file):
+    """Manages models with Ollama using the autollama.sh script.
+
+    Args:
+        model_path (str): The path to the Hugging Face model.
+        gguf_file (str): The name of the GGUF file. 
+    """
+
+    # Get the directory where this script is located
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+
+    # Construct the path to the shell script
+    script_path = os.path.join(script_dir, "autollama.sh") 
+
+    # Initialize command list
+    command = ["bash", script_path, "-m", model_path, "-g", gguf_file]
+
+    # Execute the command
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+
+    # Print the output and error in real-time
+    for line in process.stdout:
+        print(line, end='')
+
+    for line in process.stderr:
+        print(line, end='')
+
+    process.wait()
+
+def main():
+    parser = argparse.ArgumentParser(description='Run autollama.sh to manage models with Ollama')
+    parser.add_argument('-m', '--model_path', required=True, help='Set the path to the Hugging Face model')
+    parser.add_argument('-g', '--gguf_file', required=True, help='Set the GGUF file name')
+    args = parser.parse_args()
+
+    try:
+        autollama(args.model_path, args.gguf_file)
+    except Exception as e:
+        print(f"Error: {e}")
+        exit(1)
+
+if __name__ == "__main__":
+    main()

webscout-3.7/webscout/Extra/gguf.py

@@ -0,0 +1,80 @@
+import subprocess
+import argparse
+import os 
+
+def convert(model_id, username=None, token=None, quantization_methods="q4_k_m,q5_k_m"):
+    """Converts and quantizes a Hugging Face model to GGUF format.
+
+    Args:
+        model_id (str): The Hugging Face model ID (e.g., 'google/flan-t5-xl').
+        username (str, optional): Your Hugging Face username. Required for uploads.
+        token (str, optional): Your Hugging Face API token. Required for uploads. 
+        quantization_methods (str, optional): Comma-separated quantization methods. 
+                                                Defaults to "q4_k_m,q5_k_m".
+
+    Raises:
+        ValueError: If an invalid quantization method is provided.
+    """
+
+    # List of valid quantization methods
+    valid_methods = [
+        "q2_k", "q3_k_l", "q3_k_m", "q3_k_s", 
+        "q4_0", "q4_1", "q4_k_m", "q4_k_s", 
+        "q5_0", "q5_1", "q5_k_m", "q5_k_s", 
+        "q6_k", "q8_0"
+    ]
+    
+    # Validate the selected quantization methods
+    selected_methods_list = quantization_methods.split(',')
+    for method in selected_methods_list:
+        if method not in valid_methods:
+            raise ValueError(f"Invalid method: {method}. Please select from the available methods: {', '.join(valid_methods)}")
+    
+    # Get the directory where this script is located
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+
+    # Construct the path to the shell script
+    script_path = os.path.join(script_dir, "gguf.sh")
+
+    # Construct the command
+    command = ["bash", script_path, "-m", model_id]
+    
+    if username:
+        command.extend(["-u", username])
+    
+    if token:
+        command.extend(["-t", token])
+    
+    if quantization_methods:
+        command.extend(["-q", quantization_methods])
+    
+    # Execute the command
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+
+    # Print the output and error in real-time
+    for line in process.stdout:
+        print(line, end='')
+
+    for line in process.stderr:
+        print(line, end='')
+    
+    process.wait()
+
+def main():
+    parser = argparse.ArgumentParser(description='Convert and quantize model using gguf.sh')
+    parser.add_argument('-m', '--model_id', required=True, help='Set the HF model ID (e.g., "google/flan-t5-xl")')
+    parser.add_argument('-u', '--username', help='Set your Hugging Face username (required for uploads)')
+    parser.add_argument('-t', '--token', help='Set your Hugging Face API token (required for uploads)')
+    parser.add_argument('-q', '--quantization_methods', default="q4_k_m,q5_k_m", 
+                        help='Comma-separated quantization methods (default: q4_k_m,q5_k_m). Valid methods: q2_k, q3_k_l, q3_k_m, q3_k_s, q4_0, q4_1, q4_k_m, q4_k_s, q5_0, q5_1, q5_k_m, q5_k_s, q6_k, q8_0')
+    
+    args = parser.parse_args()
+    
+    try:
+        convert(args.model_id, args.username, args.token, args.quantization_methods)
+    except ValueError as e:
+        print(e)
+        exit(1)
+
+if __name__ == "__main__":
+    main()

{webscout-3.6 → webscout-3.7}/webscout/Local/_version.py

@@ -1,3 +1,3 @@
 from llama_cpp import __version__ as __llama_cpp_version__
 
-__version__ = '3.4'
+__version__ = '3.7'

{webscout-3.6 → webscout-3.7}/webscout/__init__.py

@@ -11,7 +11,7 @@ from .LLM import LLM
 import g4f
 # Import provider classes for direct access
 from .Provider import *
-
+from .Extra import *
 __repo__ = "https://github.com/OE-LUCIFER/Webscout"
 
 webai = [

webscout-3.7/webscout/version.py

@@ -0,0 +1,2 @@
+__version__ = "3.7"
+

{webscout-3.6 → webscout-3.7/webscout.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 3.6
-Summary: Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
+Version: 3.7
+Summary: Search for anything using Google, DuckDuckGo, brave, qwant,  phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs and more
 Author: OEvortex
 Author-email: helpingai5@gmail.com
 License: HelpingAI
@@ -62,7 +62,7 @@ Provides-Extra: local
 Requires-Dist: llama-cpp-python; extra == "local"
 Requires-Dist: colorama; extra == "local"
 Requires-Dist: numpy; extra == "local"
-Requires-Dist: huggingface_hub; extra == "local"
+Requires-Dist: huggingface_hub[cli]; extra == "local"
 
 <div align="center">
   <!-- Replace `#` with your actual links -->
@@ -1447,13 +1447,19 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
-### `Local-LLM` webscout can now run GGUF models
-Local LLM's some functions are taken from easy-llama
+
+##  Local-LLM
+
+Webscout can now run GGUF models locally. You can download and run your favorite models with minimal configuration.
+
+**Example:**
+
 ```python
 from webscout.Local.utils import download_model
 from webscout.Local.model import Model
 from webscout.Local.thread import Thread
 from webscout.Local import formats
+
 # 1. Download the model
 repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
 filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
@@ -1469,7 +1475,11 @@ thread = Thread(model, formats.phi3)
 thread.interact()
 ```
 
-### `Local-rawdog`
+## Local-rawdog
+Webscout's local raw-dog feature allows you to run Python scripts within your terminal prompt.
+
+**Example:**
+
 ```python
 import webscout.Local as ws
 from webscout.Local.rawdog import RawDog
@@ -1556,6 +1566,63 @@ while True:
         print(script_output)
 
 ```
+
+##  GGUF 
+
+Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for use with offline LLMs.
+
+**Example:**
+
+```python
+from webscout import gguf
+"""
+Valid quantization methods:
+"q2_k", "q3_k_l", "q3_k_m", "q3_k_s", 
+"q4_0", "q4_1", "q4_k_m", "q4_k_s", 
+"q5_0", "q5_1", "q5_k_m", "q5_k_s", 
+"q6_k", "q8_0"
+"""
+gguf.convert(
+    model_id="OEvortex/HelpingAI-Lite-1.5T",  # Replace with your model ID
+    username="Abhaykoul",  # Replace with your Hugging Face username
+    token="hf_token_write",  # Replace with your Hugging Face token
+    quantization_methods="q4_k_m"  # Optional, adjust quantization methods
+)
+```
+
+## Autollama
+
+Webscout's `autollama` utility download model from huggingface and then automatically makes it ollama ready
+
+**Example:**
+
+```python
+from webscout import autollama
+
+autollama.autollama(
+    model_path="OEvortex/HelpingAI-Lite-1.5T",  # Hugging Face model ID
+    gguf_file="HelpingAI-Lite-1.5T.q4_k_m.gguf" #  GGUF file ID
+)
+```
+
+**Command Line Usage:**
+
+* **GGUF Conversion:**
+   ```bash
+   python -m webscout.Extra.gguf -m "OEvortex/HelpingAI-Lite-1.5T" -u "your_username" -t "your_hf_token" -q "q4_k_m,q5_k_m" 
+   ```
+
+* **Autollama:**
+   ```bash
+   python -m webscout.Extra.autollama -m "OEvortex/HelpingAI-Lite-1.5T" -g "HelpingAI-Lite-1.5T.q4_k_m.gguf" 
+   ```
+
+**Note:** 
+
+* Replace `"your_username"` and `"your_hf_token"` with your actual Hugging Face credentials.
+* The `model_path` in `autollama` is the Hugging Face model ID, and `gguf_file` is the GGUF file ID.
+
+
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-3.6 → webscout-3.7}/webscout.egg-info/SOURCES.txt

@@ -28,6 +28,9 @@ webscout.egg-info/dependency_links.txt
 webscout.egg-info/entry_points.txt
 webscout.egg-info/requires.txt
 webscout.egg-info/top_level.txt
+webscout/Extra/__init__.py
+webscout/Extra/autollama.py
+webscout/Extra/gguf.py
 webscout/Local/__init__.py
 webscout/Local/_version.py
 webscout/Local/formats.py

{webscout-3.6 → webscout-3.7}/webscout.egg-info/requires.txt

@@ -38,4 +38,4 @@ pytest>=7.4.2
 llama-cpp-python
 colorama
 numpy
-huggingface_hub
+huggingface_hub[cli]

webscout-3.6/webscout/version.py

@@ -1,2 +0,0 @@
-__version__ = "3.4"
-