File size: 8,369 Bytes
cbc00ce | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
import time
from http import HTTPStatus
from typing import Iterator, Union
from dashscope.client.base_api import (
CancelMixin,
CreateMixin,
DeleteMixin,
GetStatusMixin,
ListMixin,
LogMixin,
StreamEventMixin,
)
from dashscope.common.constants import TaskStatus
from dashscope.customize.customize_types import (
FineTune,
FineTuneCancel,
FineTuneDelete,
FineTuneEvent,
FineTuneList,
)
class FineTunes(
CreateMixin,
CancelMixin,
DeleteMixin,
ListMixin,
GetStatusMixin,
StreamEventMixin,
LogMixin,
):
SUB_PATH = "fine-tunes"
@classmethod
# type: ignore[override]
# pylint: disable=arguments-renamed,dangerous-default-value
def call( # noqa: E501 # type: ignore[override]
cls,
model: str,
training_file_ids: Union[list, str],
validation_file_ids: Union[list, str] = None,
mode: str = None,
hyper_parameters: dict = {},
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTune:
"""Create fine-tune job
Args:
model (str): The model to be fine-tuned
training_file_ids (list, str): Ids of the fine-tune training data,
which can be pre-uploaded using the File API.
validation_file_ids ([list,str], optional): Ids of the fine-tune
validating data, which can be pre-uploaded using the File API.
mode (str): The fine-tune mode, sft or efficient_sft.
hyper_parameters (dict, optional): The fine-tune hyper parameters.
Defaults to empty.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The request result.
"""
if isinstance(training_file_ids, str):
training_file_ids = [training_file_ids]
if validation_file_ids and isinstance(validation_file_ids, str):
validation_file_ids = [validation_file_ids]
request = {
"model": model,
"training_file_ids": training_file_ids,
"validation_file_ids": validation_file_ids,
"hyper_parameters": hyper_parameters if hyper_parameters else {},
}
if mode is not None:
request["training_type"] = mode
if "finetuned_output" in kwargs:
request["finetuned_output"] = kwargs["finetuned_output"]
resp = super().call(
request,
api_key=api_key,
workspace=workspace,
**kwargs,
)
return FineTune(**resp)
@classmethod
def cancel( # type: ignore[override]
cls,
job_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTuneCancel:
"""Cancel a running fine-tune job.
Args:
job_id (str): The fine-tune job id.
api_key (str, optional): The api api_key, can be None,
if None, will get by default rule(TODO: api key doc).
workspace (str): The dashscope workspace id.
Returns:
FineTune: The request result.
"""
rsp = super().cancel(
job_id,
api_key=api_key,
workspace=workspace,
**kwargs,
)
return FineTuneCancel(**rsp)
@classmethod
def list( # type: ignore[override]
cls,
page_no=1,
page_size=10,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTuneList:
"""List fine-tune job.
Args:
api_key (str, optional): The api key
page_no (int, optional): Page number. Defaults to 1.
page_size (int, optional): Items per page. Defaults to 10.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The fine-tune jobs in the result.
"""
response = super().list(
page_no=page_no,
page_size=page_size,
api_key=api_key,
workspace=workspace,
**kwargs,
)
return FineTuneList(**response)
@classmethod
def get( # type: ignore[override]
cls,
job_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTune:
"""Get fine-tune job information.
Args:
job_id (str): The fine-tune job id
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The job info
"""
response = super().get(
job_id,
api_key=api_key,
workspace=workspace,
**kwargs,
)
return FineTune(**response)
@classmethod
def delete( # type: ignore[override]
cls,
job_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTuneDelete:
"""Delete a fine-tune job.
Args:
job_id (str): The fine-tune job id.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The delete result.
"""
rsp = super().delete(
job_id,
api_key=api_key,
workspace=workspace,
**kwargs,
)
return FineTuneDelete(**rsp)
@classmethod
def stream_events( # type: ignore[override] # pylint: disable=arguments-renamed # noqa: E501
# type: ignore[override]
cls,
job_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> Iterator[FineTuneEvent]:
"""Get fine-tune job events.
Args:
job_id (str): The fine-tune job id
api_key (str, optional): the api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The job log events.
"""
responses = super().stream_events(
job_id,
api_key=api_key,
workspace=workspace,
**kwargs,
)
for rsp in responses:
yield FineTuneEvent(**rsp)
@classmethod
def logs( # type: ignore[override]
cls,
job_id: str,
*,
offset=1,
line=1000,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> FineTune:
"""Get log of the job.
Args:
job_id (str): The job id(used for fine-tune)
offset (int, optional): start log line. Defaults to 1.
line (int, optional): total line return. Defaults to 1000.
api_key (str, optional): The api key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
FineTune: The response
"""
return super().logs( # type: ignore[return-value]
job_id,
offset=offset,
line=line,
workspace=workspace,
api_key=api_key,
)
@classmethod
def wait(
cls,
job_id: str,
api_key: str = None,
workspace: str = None,
**kwargs,
):
try:
while True:
rsp = FineTunes.get(
job_id,
api_key=api_key,
workspace=workspace,
**kwargs,
)
if rsp.status_code == HTTPStatus.OK:
if rsp.output["status"] in [
TaskStatus.FAILED,
TaskStatus.CANCELED,
TaskStatus.SUCCEEDED,
]:
return rsp
else:
time.sleep(30)
else:
return rsp
except Exception:
# pylint: disable=broad-exception-raised,raise-missing-from
raise Exception(
f"You can stream output via: dashscope fine_tunes.stream -j "
f"{job_id}",
)
|