Best practices applid to model.sh

Author: jkthysse

src/model.sh

@@ -5,23 +5,30 @@ IFS=$'\n\t'
 
 source "$(dirname "$0")/common.sh"
 
+# model.sh - Functions for managing Ollama models in LiteLLM Service
+# Each function is responsible for a single aspect of model management.
+
 function model_select() {
+    # Lists available Ollama models and prompts user to select one
     need_cmd ollama
     info "Available Ollama models:"
     ollama list | awk '{print NR-1")", $1}' | tail -n +2
     echo ""
-    read -p "Enter model name: " CUSTOM_MODEL_NAME
-    export CUSTOM_MODEL_NAME
+    local model_name
+    read -p "Enter model name: " model_name
+    export CUSTOM_MODEL_NAME="$model_name"
     info "Selected model: ${CUSTOM_MODEL_NAME}"
 }
 
 function model_create(){
+    # Creates a custom Ollama model from a Modelfile
     need_cmd ollama
-    local name_arg="${1:-}"
-    local file_arg="${2:-}"
+    local name_arg file_arg
+    name_arg="${1:-}"
+    file_arg="${2:-}"
 
-    if [ -n "${name_arg:-}" ]; then CUSTOM_MODEL_NAME="$name_arg"; fi
-    if [ -n "${file_arg:-}" ]; then CUSTOM_MODEL_FILE="$file_arg"; fi
+    if [ -n "$name_arg" ]; then CUSTOM_MODEL_NAME="$name_arg"; fi
+    if [ -n "$file_arg" ]; then CUSTOM_MODEL_FILE="$file_arg"; fi
 
     require_value CUSTOM_MODEL_NAME "Enter model name" "$CUSTOM_MODEL_NAME"
     require_value CUSTOM_MODEL_FILE "Enter Modelfile path" "$CUSTOM_MODEL_FILE"
@@ -36,13 +43,15 @@ function model_create(){
 }
 
 function model_test(){
+    # Tests the custom model by sending a prompt to the Ollama API
     need_cmd curl
     require_value CUSTOM_MODEL_NAME "Enter model name" "$CUSTOM_MODEL_NAME"
     info "Testing custom model '${CUSTOM_MODEL_NAME}'..."
     curl -s "$OLLAMA_API_BASE/api/generate" -d "{\n        \"model\": \"${CUSTOM_MODEL_NAME}\",\n        \"prompt\": \"Hello\"\n    }" | cat
 }
 
 function model_run(){
+    # Runs the custom model using Ollama
     need_cmd ollama
     require_value CUSTOM_MODEL_NAME "Enter model name" "$CUSTOM_MODEL_NAME"
     info "Running custom model '${CUSTOM_MODEL_NAME}'..."