litellm/tests/batches_tests/test_fine_tuning_api.py
yuneng-jiang 6a0d03914c
test: drop the cwd-relative sys.path.insert calls from the test suite (#37802)
* test: drop the cwd-relative sys.path.insert calls from the test suite

TQ003 stands at 1,077 across 1,058 files, and 1,015 of them are the same shape:
sys.path.insert(0, os.path.abspath("../..")) and its deeper siblings. The
argument resolves against the working directory rather than the file, so from
the repo root, where every job runs pytest, it inserts the directory two levels
above the checkout. It has never pointed at litellm. The package is installed
into the environment anyway, which is what actually makes the import work, and
what the rule's message has said all along.

Removing them leaves 1,634 imports of sys and os with no remaining reference,
and those go too, except where another test module imports the name back out of
the file. The rest of TQ003 is 62 call sites that resolve against __file__ or a
variable, which are a different question and are left alone.

Collection is identical either way: 45,871 tests and the same 51 pre-existing
collection errors before and after, and ruff reports no new undefined name.

* test: drop the duplicate imports the sys.path sweep exposed to F811

* test(pre-call-utils): restore the os import the new bedrock tests need
2026-08-22 09:25:58 -07:00

523 lines
19 KiB
Python

import traceback
import json
import pytest
from openai import APITimeoutError as Timeout
import litellm
litellm.num_retries = 0
import asyncio
from typing import Optional
from test_openai_batches_and_files import load_vertex_ai_credentials
from litellm import create_fine_tuning_job
from litellm.llms.vertex_ai.fine_tuning.handler import (
FineTuningJobCreate,
VertexFineTuningAPI,
)
from litellm.types.llms.openai import Hyperparameters
from litellm.integrations.custom_logger import CustomLogger
from litellm.types.utils import StandardLoggingPayload
from unittest.mock import patch, MagicMock, AsyncMock
vertex_finetune_api = VertexFineTuningAPI()
class TestCustomLogger(CustomLogger):
def __init__(self):
super().__init__()
self.standard_logging_object: Optional[StandardLoggingPayload] = None
async def async_log_success_event(self, kwargs, response_obj, start_time, end_time):
print(
"Success event logged with kwargs=",
kwargs,
"and response_obj=",
response_obj,
)
self.standard_logging_object = kwargs["standard_logging_object"]
@pytest.mark.asyncio()
async def test_create_vertex_fine_tune_jobs_mocked():
# Define reusable variables for the test
project_id = "633608382793"
location = "us-central1"
job_id = "3978211980451250176"
base_model = "gemini-1.0-pro-002"
tuned_model_name = f"{base_model}-f9259f2c-3fdf-4dd3-9413-afef2bfd24f5"
training_file = (
"gs://cloud-samples-data/ai-platform/generative_ai/sft_train_data.jsonl"
)
create_time = "2024-12-31T22:40:20.211140Z"
mock_response = AsyncMock()
mock_response.status_code = 200
mock_response.json = MagicMock(
return_value={
"name": f"projects/{project_id}/locations/{location}/tuningJobs/{job_id}",
"tunedModelDisplayName": tuned_model_name,
"baseModel": base_model,
"supervisedTuningSpec": {"trainingDatasetUri": training_file},
"state": "JOB_STATE_PENDING",
"createTime": create_time,
"updateTime": create_time,
}
)
# Save original callbacks to restore later
original_callbacks = litellm.callbacks
original_success_callback = litellm.success_callback
original_async_success_callback = litellm._async_success_callback
# Disable all callbacks to avoid Datadog/other loggers interfering with the mock
litellm.callbacks = []
litellm.success_callback = []
litellm._async_success_callback = []
try:
with (
patch(
"litellm.llms.custom_httpx.http_handler.AsyncHTTPHandler.post",
return_value=mock_response,
) as mock_post,
patch(
"litellm.llms.vertex_ai.vertex_llm_base.VertexBase._ensure_access_token",
return_value=("fake-token", project_id),
),
):
create_fine_tuning_response = await litellm.acreate_fine_tuning_job(
model=base_model,
custom_llm_provider="vertex_ai",
training_file=training_file,
vertex_project=project_id,
vertex_location=location,
)
# Verify the request - filter to only Vertex AI calls (Datadog batch logger
# may flush in the background and make additional POST calls)
vertex_calls = [
c
for c in mock_post.call_args_list
if "aiplatform.googleapis.com" in str(c.kwargs.get("url", ""))
]
assert len(vertex_calls) == 1
# Validate the request
assert vertex_calls[0].kwargs["json"] == {
"baseModel": base_model,
"supervisedTuningSpec": {"training_dataset_uri": training_file},
"tunedModelDisplayName": None,
}
# Verify the response
response_json = json.loads(create_fine_tuning_response.model_dump_json())
assert (
response_json["id"]
== f"projects/{project_id}/locations/{location}/tuningJobs/{job_id}"
)
assert response_json["model"] == base_model
assert response_json["object"] == "fine_tuning.job"
assert response_json["fine_tuned_model"] == tuned_model_name
assert response_json["status"] == "queued"
assert response_json["training_file"] == training_file
assert (
response_json["created_at"] == 1735684820
) # Unix timestamp for create_time
assert response_json["error"] is None
assert response_json["finished_at"] is None
assert response_json["validation_file"] is None
assert response_json["trained_tokens"] is None
assert response_json["estimated_finish"] is None
assert response_json["integrations"] == []
finally:
# Restore original callbacks
litellm.callbacks = original_callbacks
litellm.success_callback = original_success_callback
litellm._async_success_callback = original_async_success_callback
@pytest.mark.asyncio()
async def test_create_vertex_fine_tune_jobs_mocked_with_hyperparameters():
# Define reusable variables for the test
project_id = "633608382793"
location = "us-central1"
job_id = "3978211980451250176"
base_model = "gemini-1.0-pro-002"
tuned_model_name = f"{base_model}-f9259f2c-3fdf-4dd3-9413-afef2bfd24f5"
training_file = (
"gs://cloud-samples-data/ai-platform/generative_ai/sft_train_data.jsonl"
)
create_time = "2024-12-31T22:40:20.211140Z"
mock_response = AsyncMock()
mock_response.status_code = 200
mock_response.json = MagicMock(
return_value={
"name": f"projects/{project_id}/locations/{location}/tuningJobs/{job_id}",
"tunedModelDisplayName": tuned_model_name,
"baseModel": base_model,
"supervisedTuningSpec": {"trainingDatasetUri": training_file},
"state": "JOB_STATE_PENDING",
"createTime": create_time,
"updateTime": create_time,
}
)
# Save original callbacks to restore later
original_callbacks = litellm.callbacks
original_success_callback = litellm.success_callback
original_async_success_callback = litellm._async_success_callback
# Disable all callbacks to avoid Datadog/other loggers interfering with the mock
litellm.callbacks = []
litellm.success_callback = []
litellm._async_success_callback = []
try:
with (
patch(
"litellm.llms.custom_httpx.http_handler.AsyncHTTPHandler.post",
return_value=mock_response,
) as mock_post,
patch(
"litellm.llms.vertex_ai.vertex_llm_base.VertexBase._ensure_access_token",
return_value=("fake-token", project_id),
),
):
create_fine_tuning_response = await litellm.acreate_fine_tuning_job(
model=base_model,
custom_llm_provider="vertex_ai",
training_file=training_file,
vertex_project=project_id,
vertex_location=location,
hyperparameters={
"n_epochs": 5,
"learning_rate_multiplier": 0.2,
"adapter_size": "SMALL",
},
)
# Verify the request - filter to only Vertex AI calls (Datadog batch logger
# may flush in the background and make additional POST calls)
vertex_calls = [
c
for c in mock_post.call_args_list
if "aiplatform.googleapis.com" in str(c.kwargs.get("url", ""))
]
assert len(vertex_calls) == 1
# Validate the request
assert vertex_calls[0].kwargs["json"] == {
"baseModel": base_model,
"supervisedTuningSpec": {
"training_dataset_uri": training_file,
"hyperParameters": {
"epoch_count": 5,
"learning_rate_multiplier": 0.2,
"adapter_size": "SMALL",
},
},
"tunedModelDisplayName": None,
}
# Verify the response
response_json = json.loads(create_fine_tuning_response.model_dump_json())
assert (
response_json["id"]
== f"projects/{project_id}/locations/{location}/tuningJobs/{job_id}"
)
assert response_json["model"] == base_model
assert response_json["object"] == "fine_tuning.job"
assert response_json["fine_tuned_model"] == tuned_model_name
assert response_json["status"] == "queued"
assert response_json["training_file"] == training_file
assert (
response_json["created_at"] == 1735684820
) # Unix timestamp for create_time
assert response_json["error"] is None
assert response_json["finished_at"] is None
assert response_json["validation_file"] is None
assert response_json["trained_tokens"] is None
assert response_json["estimated_finish"] is None
assert response_json["integrations"] == []
finally:
# Restore original callbacks
litellm.callbacks = original_callbacks
litellm.success_callback = original_success_callback
litellm._async_success_callback = original_async_success_callback
# Testing OpenAI -> Vertex AI param mapping
def test_convert_openai_request_to_vertex_basic():
openai_data = FineTuningJobCreate(
training_file="gs://bucket/train.jsonl",
validation_file="gs://bucket/val.jsonl",
model="text-davinci-002",
hyperparameters={"n_epochs": 3, "learning_rate_multiplier": 0.1},
suffix="my_fine_tuned_model",
)
result = vertex_finetune_api.convert_openai_request_to_vertex(openai_data)
print("converted vertex ai result=", json.dumps(result, indent=4))
assert result["baseModel"] == "text-davinci-002"
assert result["tunedModelDisplayName"] == "my_fine_tuned_model"
assert (
result["supervisedTuningSpec"]["training_dataset_uri"]
== "gs://bucket/train.jsonl"
)
assert (
result["supervisedTuningSpec"]["validation_dataset"] == "gs://bucket/val.jsonl"
)
assert result["supervisedTuningSpec"]["hyperParameters"]["epoch_count"] == 3
assert (
result["supervisedTuningSpec"]["hyperParameters"]["learning_rate_multiplier"]
== 0.1
)
def test_convert_openai_request_to_vertex_with_adapter_size():
original_hyperparameters = {
"n_epochs": 5,
"learning_rate_multiplier": 0.2,
"adapter_size": "SMALL",
}
openai_data = FineTuningJobCreate(
training_file="gs://bucket/train.jsonl",
model="text-davinci-002",
hyperparameters=Hyperparameters(**original_hyperparameters),
suffix="custom_model",
)
result = vertex_finetune_api.convert_openai_request_to_vertex(
openai_data, original_hyperparameters=original_hyperparameters
)
print("converted vertex ai result=", json.dumps(result, indent=4))
assert result["baseModel"] == "text-davinci-002"
assert result["tunedModelDisplayName"] == "custom_model"
assert (
result["supervisedTuningSpec"]["training_dataset_uri"]
== "gs://bucket/train.jsonl"
)
assert result["supervisedTuningSpec"]["hyperParameters"]["epoch_count"] == 5
assert (
result["supervisedTuningSpec"]["hyperParameters"]["learning_rate_multiplier"]
== 0.2
)
assert result["supervisedTuningSpec"]["hyperParameters"]["adapter_size"] == "SMALL"
def test_convert_basic_openai_request_to_vertex_request():
openai_data = FineTuningJobCreate(
training_file="gs://bucket/train.jsonl",
model="gemini-1.0-pro-002",
)
result = vertex_finetune_api.convert_openai_request_to_vertex(
openai_data,
)
print("converted vertex ai result=", json.dumps(result, indent=4))
assert result["baseModel"] == "gemini-1.0-pro-002"
assert result["tunedModelDisplayName"] == None
assert (
result["supervisedTuningSpec"]["training_dataset_uri"]
== "gs://bucket/train.jsonl"
)
@pytest.mark.asyncio
async def test_mock_openai_create_fine_tune_job():
"""Test that create_fine_tuning_job sends correct parameters to OpenAI"""
from openai import AsyncOpenAI
from openai.types.fine_tuning.fine_tuning_job import FineTuningJob, Hyperparameters
custom_logger = TestCustomLogger()
previous_callbacks = litellm.callbacks
litellm.callbacks = [custom_logger]
client = AsyncOpenAI(api_key="fake-api-key")
with patch.object(client.fine_tuning.jobs, "create") as mock_create:
mock_create.return_value = FineTuningJob(
id="ft-123",
model="gpt-4o-mini-2024-07-18",
created_at=1677610602,
status="validating_files",
fine_tuned_model="ft:gpt-4o-mini-2024-07-18:org:custom_suffix:id",
object="fine_tuning.job",
hyperparameters=Hyperparameters(
n_epochs=3,
),
organization_id="org-123",
seed=42,
training_file="file-123",
result_files=[],
)
response = await litellm.acreate_fine_tuning_job(
model="gpt-4o-mini-2024-07-18",
training_file="file-123",
hyperparameters={"n_epochs": 3},
suffix="custom_suffix",
client=client,
)
# Verify the request
mock_create.assert_called_once()
request_params = mock_create.call_args.kwargs
assert request_params["model"] == "gpt-4o-mini-2024-07-18"
assert request_params["training_file"] == "file-123"
assert request_params["hyperparameters"] == {"n_epochs": 3}
assert request_params["suffix"] == "custom_suffix"
# Verify the response
assert response.id == "ft-123"
assert response.model == "gpt-4o-mini-2024-07-18"
assert response.status == "validating_files"
assert (
response.fine_tuned_model
== "ft:gpt-4o-mini-2024-07-18:org:custom_suffix:id"
)
try:
for _ in range(20):
if custom_logger.standard_logging_object is not None:
break
await asyncio.sleep(0.25)
logged = custom_logger.standard_logging_object
assert logged is not None
assert logged["model"] == "gpt-4o-mini-2024-07-18"
assert logged["id"] == response.id
assert logged["call_type"] == "acreate_fine_tuning_job"
finally:
litellm.callbacks = previous_callbacks
@pytest.mark.asyncio
async def test_mock_openai_list_fine_tune_jobs():
"""Test that list_fine_tuning_jobs sends correct parameters to OpenAI"""
from openai import AsyncOpenAI
from unittest.mock import AsyncMock
client = AsyncOpenAI(api_key="fake-api-key")
with patch.object(
client.fine_tuning.jobs, "list", new_callable=AsyncMock
) as mock_list:
# Simple mock return value - actual structure doesn't matter for this test
mock_list.return_value = []
await litellm.alist_fine_tuning_jobs(limit=2, after="ft-000", client=client)
# Only verify that the client was called with correct parameters
mock_list.assert_called_once()
request_params = mock_list.call_args.kwargs
assert request_params["limit"] == 2
assert request_params["after"] == "ft-000"
@pytest.mark.asyncio
async def test_mock_openai_cancel_fine_tune_job():
"""Test that cancel_fine_tuning_job sends correct parameters to OpenAI"""
from openai import AsyncOpenAI
client = AsyncOpenAI(api_key="fake-api-key")
with patch.object(client.fine_tuning.jobs, "cancel") as mock_cancel:
try:
await litellm.acancel_fine_tuning_job(
fine_tuning_job_id="ft-123", client=client
)
except Exception as e:
print("error=", e)
# Only verify that the client was called with correct parameters
mock_cancel.assert_called_once_with(fine_tuning_job_id="ft-123")
@pytest.mark.asyncio
async def test_mock_openai_retrieve_fine_tune_job():
"""Test that retrieve_fine_tuning_job sends correct parameters to OpenAI"""
from openai import AsyncOpenAI
client = AsyncOpenAI(api_key="fake-api-key")
with patch.object(client.fine_tuning.jobs, "retrieve") as mock_retrieve:
try:
response = await litellm.aretrieve_fine_tuning_job(
fine_tuning_job_id="ft-123", client=client
)
except Exception as e:
print("error=", e)
# Verify the request
mock_retrieve.assert_called_once_with(fine_tuning_job_id="ft-123")
@pytest.mark.asyncio
async def test_mock_azure_create_fine_tune_job_with_azure_specific_params():
"""Test that Azure-specific parameters are passed through extra_body"""
from openai.types.fine_tuning.fine_tuning_job import (
Hyperparameters as OAIHyperparameters,
)
from litellm.types.utils import LiteLLMFineTuningJob
mock_response = LiteLLMFineTuningJob(
id="ft-azure-123",
model="gpt-4.1-mini-2025-04-14",
created_at=1677610602,
status="validating_files",
fine_tuned_model=None,
object="fine_tuning.job",
hyperparameters=OAIHyperparameters(n_epochs=3),
organization_id="org-123",
seed=42,
training_file="file-123",
result_files=[],
)
async def mock_async_create(*args, **kwargs):
return mock_response
with patch(
"litellm.llms.azure.fine_tuning.handler.AzureOpenAIFineTuningAPI.create_fine_tuning_job"
) as mock_create:
mock_create.return_value = mock_async_create()
response = await litellm.acreate_fine_tuning_job(
model="gpt-4.1-mini-2025-04-14",
training_file="file-123",
custom_llm_provider="azure",
api_base="https://test.openai.azure.com",
api_key="test-key",
api_version="2025-04-01-preview",
trainingType=1,
hyperparameters={"n_epochs": 3, "prompt_loss_weight": 0.1},
)
# Verify the request
mock_create.assert_called_once()
request_params = mock_create.call_args.kwargs
# Check that create_fine_tuning_job_data contains the correct structure
create_data = request_params["create_fine_tuning_job_data"]
assert create_data["model"] == "gpt-4.1-mini-2025-04-14"
assert create_data["training_file"] == "file-123"
assert create_data["hyperparameters"] == {"n_epochs": 3}
# Azure-specific parameters should be in extra_body
assert "extra_body" in create_data
assert create_data["extra_body"]["trainingType"] == 1
assert create_data["extra_body"]["prompt_loss_weight"] == 0.1
# Verify the response
assert response.id == "ft-azure-123"
assert response.model == "gpt-4.1-mini-2025-04-14"