webscout 3.7__py3-none-any.whl → 3.8__py3-none-any.whl

webscout/Extra/autollama.py

@@ -10,11 +10,161 @@ def autollama(model_path, gguf_file):
         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__))
+    # Check if autollama.sh exists in the current working directory
+    script_path = os.path.join(os.getcwd(), "autollama.sh")
+    if not os.path.exists(script_path):
+        # Create autollama.sh with the content provided
+        with open(script_path, "w") as f:
+            f.write("""
+function show_art() {
+    cat << "EOF"
+    Made with love in India
+EOF
+}
 
-    # Construct the path to the shell script
-    script_path = os.path.join(script_dir, "autollama.sh") 
+show_art
+
+# Initialize default values
+MODEL_PATH=""
+GGUF_FILE=""
+
+# Display help/usage information
+usage() {
+echo "Usage: $0 -m <model_path> -g <gguf_file>"
+echo
+echo "Options:"
+echo "  -m <model_path>    Set the path to the model"
+echo "  -g <gguf_file>     Set the GGUF file name"
+echo "  -h                 Display this help and exit"
+echo
+}
+
+# Parse command-line options
+while getopts ":m:g:h" opt; do
+case ${opt} in
+    m )
+    MODEL_PATH=$OPTARG
+    ;;
+    g )
+    GGUF_FILE=$OPTARG
+    ;;
+    h )
+    usage
+    exit 0
+    ;;
+    \? )
+    echo "Invalid Option: -$OPTARG" 1>&2
+    usage
+    exit 1
+    ;;
+    : )
+    echo "Invalid Option: -$OPTARG requires an argument" 1>&2
+    usage
+    exit 1
+    ;;
+esac
+done
+
+# Check required parameters
+if [ -z "$MODEL_PATH" ] || [ -z "$GGUF_FILE" ]; then
+    echo "Error: -m (model_path) and -g (gguf_file) are required."
+    usage
+    exit 1
+fi
+
+# Derive MODEL_NAME
+MODEL_NAME=$(echo $GGUF_FILE | sed 's/\(.*\)\.Q4.*/\\1/')
+
+# Log file where downloaded models are recorded
+DOWNLOAD_LOG="downloaded_models.log"
+
+# Composite logging name
+LOGGING_NAME="${MODEL_PATH}_${MODEL_NAME}"
+
+# Check if the model has been downloaded
+function is_model_downloaded {
+    grep -qxF "$LOGGING_NAME" "$DOWNLOAD_LOG" && return 0 || return 1
+}
+
+# Log the downloaded model
+function log_downloaded_model {
+    echo "$LOGGING_NAME" >> "$DOWNLOAD_LOG"
+}
+
+# Function to check if the model has already been created
+function is_model_created {
+    # 'ollama list' lists all models
+    ollama list | grep -q "$MODEL_NAME" && return 0 || return 1
+}
+
+# Check if huggingface-hub is installed, and install it if not
+if ! pip show huggingface-hub > /dev/null; then
+echo "Installing huggingface-hub..."
+pip install -U "huggingface_hub[cli]"
+else
+echo "huggingface-hub is already installed."
+fi
+
+# Check if the model has already been downloaded
+if is_model_downloaded; then
+    echo "Model $LOGGING_NAME has already been downloaded. Skipping download."
+else
+    echo "Downloading model $LOGGING_NAME..."
+    # Download the model
+    huggingface-cli download $MODEL_PATH $GGUF_FILE --local-dir downloads --local-dir-use-symlinks False
+
+    # Log the downloaded model
+    log_downloaded_model
+    echo "Model $LOGGING_NAME downloaded and logged."
+fi
+
+# Check if Ollama is installed, and install it if not
+if ! command -v ollama &> /dev/null; then
+echo "Installing Ollama..."
+curl -fsSL https://ollama.com/install.sh | sh
+else
+echo "Ollama is already installed."
+fi
+
+# Check if Ollama is already running
+if pgrep -f 'ollama serve' > /dev/null; then
+    echo "Ollama is already running. Skipping the start."
+else
+    echo "Starting Ollama..."
+    # Start Ollama in the background
+    ollama serve &
+
+    # Wait for Ollama to start
+    while true; do
+        if pgrep -f 'ollama serve' > /dev/null; then
+            echo "Ollama has started."
+            sleep 60
+            break
+        else
+            echo "Waiting for Ollama to start..."
+            sleep 1 # Wait for 1 second before checking again
+        fi
+    done
+fi
+
+# Check if the model has already been created
+if is_model_created; then
+    echo "Model $MODEL_NAME is already created. Skipping creation."
+else
+    echo "Creating model $MODEL_NAME..."
+    # Create the model in Ollama
+    # Prepare Modelfile with the downloaded path
+    echo "FROM ./downloads/$GGUF_FILE" > Modelfile
+    ollama create $MODEL_NAME -f Modelfile
+    echo "Model $MODEL_NAME created."
+fi
+
+
+echo "model name is > $MODEL_NAME"
+echo "Use Ollama run $MODEL_NAME"
+            """)
+        # Make autollama.sh executable (using chmod)
+        os.chmod(script_path, 0o755)
 
     # Initialize command list
     command = ["bash", script_path, "-m", model_path, "-g", gguf_file]
@@ -32,8 +182,8 @@ def autollama(model_path, gguf_file):
     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 = argparse.ArgumentParser(description='Automatically create and run an Ollama model in Ollama')
+    parser.add_argument('-m', '--model_path', required=True, help='Set the hunggingface model id to the Hugging Face model')
     parser.add_argument('-g', '--gguf_file', required=True, help='Set the GGUF file name')
     args = parser.parse_args()
 
@@ -44,4 +194,5 @@ def main():
         exit(1)
 
 if __name__ == "__main__":
-    main()
+    main()
+

webscout/Extra/gguf.py

@@ -1,3 +1,4 @@
+# webscout/Extra/gguf.py
 import subprocess
 import argparse
 import os 
@@ -30,11 +31,169 @@ def convert(model_id, username=None, token=None, quantization_methods="q4_k_m,q5
         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 absolute path to the shell script
+    script_path = os.path.join(os.getcwd(), "gguf.sh")
+    if not os.path.exists(script_path):
+        # Create autollama.sh with the content provided
+        with open(script_path, "w") as f:
+            f.write("""
+cat << "EOF"
+Made with love in India
+EOF
 
-    # Construct the path to the shell script
-    script_path = os.path.join(script_dir, "gguf.sh")
+# Default values
+MODEL_ID=""
+USERNAME=""
+TOKEN=""
+QUANTIZATION_METHODS="q4_k_m,q5_k_m" # Default to "q4_k_m,q5_k_m" if not provided
+
+# Display help/usage information
+usage() {
+  echo "Usage: $0 -m MODEL_ID [-u USERNAME] [-t TOKEN] [-q QUANTIZATION_METHODS]"
+  echo
+  echo "Options:"
+  echo "  -m MODEL_ID                   Required: Set the HF model ID"
+  echo "  -u USERNAME                   Optional: Set the username"
+  echo "  -t TOKEN                      Optional: Set the token"
+  echo "  -q QUANTIZATION_METHODS       Optional: Set the quantization methods (default: q4_k_m,q5_k_m)"
+  echo "  -h                            Display this help and exit"
+  echo
+}
+
+# Parse command-line options
+while getopts ":m:u:t:q:h" opt; do
+  case ${opt} in
+    m )
+      MODEL_ID=$OPTARG
+      ;;
+    u )
+      USERNAME=$OPTARG
+      ;;
+    t )
+      TOKEN=$OPTARG
+      ;;
+    q )
+      QUANTIZATION_METHODS=$OPTARG
+      ;;
+    h )
+      usage
+      exit 0
+      ;;
+    \? )
+      echo "Invalid Option: -$OPTARG" 1>&2
+      usage
+      exit 1
+      ;;
+    : )
+      echo "Invalid Option: -$OPTARG requires an argument" 1>&2
+      usage
+      exit 1
+      ;;
+  esac
+done
+shift $((OPTIND -1))
+
+# Ensure MODEL_ID is provided
+if [ -z "$MODEL_ID" ]; then
+    echo "Error: MODEL_ID is required."
+    usage
+    exit 1
+fi
+
+# # Echoing the arguments for checking
+# echo "MODEL_ID: $MODEL_ID"
+# echo "USERNAME: ${USERNAME:-'Not provided'}"
+# echo "TOKEN: ${TOKEN:-'Not provided'}"
+# echo "QUANTIZATION_METHODS: $QUANTIZATION_METHODS"
+
+# Splitting string into an array for quantization methods, if provided
+IFS=',' read -r -a QUANTIZATION_METHOD_ARRAY <<< "$QUANTIZATION_METHODS"
+echo "Quantization Methods: ${QUANTIZATION_METHOD_ARRAY[@]}"
+
+MODEL_NAME=$(echo "$MODEL_ID" | awk -F'/' '{print $NF}')
+
+
+# ----------- llama.cpp setup block-----------
+# Check if llama.cpp is already installed and skip the build step if it is
+if [ ! -d "llama.cpp" ]; then
+    echo "llama.cpp not found. Cloning and setting up..."
+    git clone https://github.com/ggerganov/llama.cpp
+    cd llama.cpp && git pull
+    # Install required packages
+    pip3 install -r requirements.txt
+    # Build llama.cpp as it's freshly cloned
+    if ! command -v nvcc &> /dev/null
+    then
+        echo "nvcc could not be found, building llama without LLAMA_CUBLAS"
+        make clean && make
+    else
+        make clean && LLAMA_CUBLAS=1 make
+    fi
+    cd ..
+else
+    echo "llama.cpp found. Assuming it's already built and up to date."
+    # Optionally, still update dependencies
+    # cd llama.cpp && pip3 install -r requirements.txt && cd ..
+fi
+# ----------- llama.cpp setup block-----------
+
+
+
+
+# Download model 
+#todo : shall we put condition to check if model has been already downloaded? similar to autogguf?
+echo "Downloading the model..."
+huggingface-cli download "$MODEL_ID" --local-dir "./${MODEL_NAME}" --local-dir-use-symlinks False --revision main
+
+
+# Convert to fp16
+FP16="${MODEL_NAME}/${MODEL_NAME,,}.fp16.bin"
+echo "Converting the model to fp16..."
+python3 llama.cpp/convert-hf-to-gguf.py "$MODEL_NAME" --outtype f16 --outfile "$FP16"
+
+# Quantize the model
+echo "Quantizing the model..."
+for METHOD in "${QUANTIZATION_METHOD_ARRAY[@]}"; do
+    QTYPE="${MODEL_NAME}/${MODEL_NAME,,}.${METHOD^^}.gguf"
+    ./llama.cpp/llama-quantize "$FP16" "$QTYPE" "$METHOD"
+done
+
+
+# Check if USERNAME and TOKEN are provided
+if [[ -n "$USERNAME" && -n "$TOKEN" ]]; then
+
+    # Login to Hugging Face
+    echo "Logging in to Hugging Face..."
+    huggingface-cli login --token "$TOKEN"
+
+
+    # Uploading .gguf, .md files, and config.json
+    echo "Uploading .gguf, .md files, and config.json..."
+
+
+    # Define a temporary directory
+    TEMP_DIR="./temp_upload_dir"
+
+    # Create the temporary directory
+    mkdir -p "${TEMP_DIR}"
+
+    # Copy the specific files to the temporary directory
+    find "./${MODEL_NAME}" -type f \( -name "*.gguf" -o -name "*.md" -o -name "config.json" \) -exec cp {} "${TEMP_DIR}/" \;
+
+    # Upload the temporary directory to Hugging Face
+    huggingface-cli upload "${USERNAME}/${MODEL_NAME}-GGUF" "${TEMP_DIR}" --private
+
+    # Remove the temporary directory after upload
+    rm -rf "${TEMP_DIR}"
+    echo "Upload completed."
+else
+    echo "USERNAME and TOKEN must be provided for upload."
+fi
+
+echo "Script completed."
+            """)
+        # Make autollama.sh executable (using chmod)
+        os.chmod(script_path, 0o755)
 
     # Construct the command
     command = ["bash", script_path, "-m", model_id]
@@ -60,6 +219,7 @@ def convert(model_id, username=None, token=None, quantization_methods="q4_k_m,q5
     
     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")')

webscout/__init__.py

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

{webscout-3.7.dist-info → webscout-3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 3.7
+Version: 3.8
 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
@@ -1599,7 +1599,7 @@ Webscout's `autollama` utility download model from huggingface and then automati
 ```python
 from webscout import autollama
 
-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
 )

{webscout-3.7.dist-info → webscout-3.8.dist-info}/RECORD

@@ -3,7 +3,7 @@ webscout/AIbase.py,sha256=GoHbN8r0gq2saYRZv6LA-Fr9Jlcjv80STKFXUq2ZeGU,4710
 webscout/AIutel.py,sha256=MMfUvTQXYDtaFXsXtwKgv9V_qMK6WgOxdx7Wagdm2Lw,33542
 webscout/DWEBS.py,sha256=QLuT1IKu0lnwdl7W6c-ctBAO7Jj0Zk3PYm6-13BC7rU,25740
 webscout/LLM.py,sha256=LbGCZdJf8A5dwfoGS4tyy39tAh5BDdhMZP0ScKaaQfU,4184
-webscout/__init__.py,sha256=WolS-VvktY4VezczjfbZuZR5iPCtCzPUV_WKqDFVIoA,2058
+webscout/__init__.py,sha256=427p-hwpbqr0RdzzkvRAPYfSCAyiPte-JeHnUWG_nHA,2091
 webscout/__main__.py,sha256=ZtTRgsRjUi2JOvYFLF1ZCh55Sdoz94I-BS-TlJC7WDU,126
 webscout/async_providers.py,sha256=holBv5SxanxVXc_92CBBaXHlB2IakB_fHnhyZaFjYF8,684
 webscout/cli.py,sha256=enw_dPTCG3sNC1TXt96XccnpRmF4Etr99nh-RbGYags,18784
@@ -20,8 +20,8 @@ webscout/webscout_search.py,sha256=lFAot1-Qil_YfXieeLakDVDEX8Ckcima4ueXdOYwiMc,4
 webscout/webscout_search_async.py,sha256=dooKGwLm0cwTml55Vy6NHPPY-nymEqX2h8laX94Zg5A,14537
 webscout/websx_search.py,sha256=n-qVwiHozJEF-GFRPcAfh4k1d_tscTmDe1dNL-1ngcU,12094
 webscout/Extra/__init__.py,sha256=vlW4RoSl5v3d7j_Yq1XEMydrG9JM-On_afgK-HtRZsk,45
-webscout/Extra/autollama.py,sha256=5OPVRETbRJomTerddMJtznE-GFAZvDx5BPRM9EQB9dU,1476
-webscout/Extra/gguf.py,sha256=HrRF0hW3HZHwtu4OCFumlRTgMBqFpqK0JKyRTRyPWrs,3122
+webscout/Extra/autollama.py,sha256=DDdnb1tKEZWJaADVn9GXTZkMSwLKCcUGIjMKNlOBtK8,5419
+webscout/Extra/gguf.py,sha256=5zTNE5HxM_VQ5ONoocL8GG5fRXrgyLdEEjNzndG0oUw,7811
 webscout/Local/__init__.py,sha256=RN6klpbabPGNX2YzPm_hdeUcQvieUwvJt22uAO2RKSM,238
 webscout/Local/_version.py,sha256=3sFn1tDa2mT9Pb1-OGW4K3_zbiJ0mhPRqB2rnLfp28Q,83
 webscout/Local/formats.py,sha256=BiZZSoN3e8S6-S-ykBL9ogSUs0vK11GaZ3ghc9U8GRk,18994
@@ -54,9 +54,9 @@ webscout/Provider/Xjai.py,sha256=BIlk2ouz9Kh_0Gg9hPvTqhI7XtcmWdg5vHSX_4uGrIs,903
 webscout/Provider/Yepchat.py,sha256=2Eit-A7w1ph1GQKNQuur_yaDzI64r0yBGxCIjDefJxQ,19875
 webscout/Provider/Youchat.py,sha256=UVGBuGSjv4uRibn1xflmCjYcfrRTKnDvX3adhag6T98,7976
 webscout/Provider/__init__.py,sha256=RaMdtYv7eQJ2vB8jXUHrkfNbx2DgRjbwc6DI40cOH1A,1809
-webscout-3.7.dist-info/LICENSE.md,sha256=9P0imsudI7MEvZe2pOcg8rKBn6E5FGHQ-riYozZI-Bk,2942
-webscout-3.7.dist-info/METADATA,sha256=FocHEEpfWeT2aX3bUXJ8mHw1cWugF3tijDNqUnehB-o,69115
-webscout-3.7.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
-webscout-3.7.dist-info/entry_points.txt,sha256=Hh4YIIjvkqB9SVxZ2ri4DZUkgEu_WF_5_r_nZDIvfG8,73
-webscout-3.7.dist-info/top_level.txt,sha256=nYIw7OKBQDr_Z33IzZUKidRD3zQEo8jOJYkMVMeN334,9
-webscout-3.7.dist-info/RECORD,,
+webscout-3.8.dist-info/LICENSE.md,sha256=9P0imsudI7MEvZe2pOcg8rKBn6E5FGHQ-riYozZI-Bk,2942
+webscout-3.8.dist-info/METADATA,sha256=hCQOSbTlIUBKkcTP9W8hPxuo0yXhkMbRHi7E0bSg4S4,69105
+webscout-3.8.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
+webscout-3.8.dist-info/entry_points.txt,sha256=Hh4YIIjvkqB9SVxZ2ri4DZUkgEu_WF_5_r_nZDIvfG8,73
+webscout-3.8.dist-info/top_level.txt,sha256=nYIw7OKBQDr_Z33IzZUKidRD3zQEo8jOJYkMVMeN334,9
+webscout-3.8.dist-info/RECORD,,