学習作成
    • PDF

    学習作成

    • PDF

    Article Summary

    Classic/VPC環境で利用できます。

    学習を作成します。作成した学習が完了した後、会話型文章を作成する APIを呼び出し、CLOVA Studioが作成した回答を確認できます。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    POST/tuning/v2/tasks

    ヘッダ

    ヘッダの説明は次の通りです。

    フィールド必須有無説明
    X-NCP-APIGW-TIMESTAMPY1970年1月1日 00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で示したもの
    API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
    x-ncp-apigw-timestamp:{Timestamp}
    X-NCP-IAM-ACCESS-KEYYNAVERクラウドプラットフォームポータルから発行された Access Key ID
    x-ncp-iam-access-key:{Main Account Access Key}
    X-NCP-APIGW-SIGNATURE-V2YAccess Key ID値と Secret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    X-NCP-CLOVASTUDIO-REQUEST-IDN各リクエストのリクエスト ID
    Content-TypeYmultipart/form-data

    ボディ

    ボディの説明は次の通りです。

    フィールドタイプ必須有無説明
    namestringN学習名(デフォルト値: 学習作成日)
    modelstringYチューニングモデル名
    tuningTypestringNチューニング技法
  • PEFT(デフォルト値)
  • taskTypestringN学習タイプ
  • GENERATION: 作成(デフォルト値)
  • CLASSIFICATION: 分類
  • trainEpochsstringNモデルを学習したエポック数
  • 1~20(デフォルト値: 4)
  • learningRatestringN学習率: チューニング時にモデルパラメータを再学習するレベルや度合い
  • 1~1.0E-6(デフォルト値: 1.0E-4)
  • trainingDatasetstringY学習するデータセットのファイルパス

    構文

    構文例は次の通りです。

    curl --location --request POST 'https://clovastudio.apigw.ntruss.com/tuning/v2/tasks' \
    --header 'Content-Type: multipart/form-data' \
    --header 'X-NCP-APIGW-TIMESTAMP: <api_gw_time>' \
    --header 'X-NCP-IAM-ACCESS-KEY: <iam_access_key>' \
    --header 'X-NCP-APIGW-SIGNATURE-V2: <api_gw_sig>' \
    --header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <request_id>' \
    --form 'name="test"' \
    --form 'model="HCX-002"' \
    --form 'method="LoRA"' \
    --form 'taskType="GENERATION"' \
    --form 'trainEpochs="4"' \
    --form 'learningRate="1.0E-4"' \
    --form 'trainingDataset=@"E:/Downloads/test.csv"'
    

    レスポンス

    レスポンス形式を説明します。

    ヘッダ

    ヘッダの説明は次の通りです。

    ヘッダ必須有無説明
    Content-Type-application/json

    ボディ

    ボディの説明は次の通りです。

    フィールドタイプ必須有無説明
    resultobject-レスポンス結果
    result.idstring-学習 ID
    result.namestring-学習名
    result.modelstring-チューニングモデル名
    result.methodstring-チューニング技法
  • LoRA
  • result.taksTypestring-学習タイプ
  • GENERATION: 作成
  • CLASSIFICATION: 分類
  • result.trainEpochsinterger-モデルを学習したエポック数
    result.learningRatedouble-学習率: チューニング時にモデルパラメータを再学習するレベルや度合い
    result.statusstring-学習進捗状態
  • WAIT
  • RUNNING
  • FAILED
  • SUCCEEDED
  • result.status.statusInfoarray-学習進捗状態の詳細情報
    result.status.statusInfo.labelarray-学習タイプが classificationの場合、ユーザーデータラベル(学習タイプが GENERATIONの場合、null)
    result.status.statusInfo.dataRowsint-データ数
    result.status.statusInfo.numOfTokensint-データトークン数
    result.status.statusInfo.currStepint-現在の学習ステップ数
    result.status.statusInfo.totalTrainStepsint-学習の総ステップ数
    result.status.statusInfo.currEpochint-現在のエポック
    result.status.statusInfo.totalTrainEpochsint-全体学習のエポック
    result.status.statusInfo.estimatedTimeint-予想所要時間(平均1エポック時間*全体学習のエポック)
    result.status.statusInfo.trainLossdouble-学習損失量
    result.status.statusInfo.sendWeightSuccessboolean-学習結果の保存有無
    result.status.statusInfo.endDatetimestring-学習終了日
    result.status.statusInfo.failureReasonstring-学習失敗理由
    • file.read: ファイル認識失敗
    • file.privacy: ファイルに個人情報存在
    • file.harmful: ファイルに有害情報存在
    • resource.timeout: GPU確保失敗でレスポンス時間超過。再試行が必要
    • result.store: 学習結果の保存に失敗
    • db.timeout: DBアクセス失敗でレスポンス時間超過。再試行が必要
    result.status.createdClientTypestring-学習をリクエストしたクライアントのタイプ
  • API: APIクライアント
  • WEB: ウェブクライアント
  • result.status.createdDatestring-学習作成日(ISO 8601形式)
    result.status.updatedDatestring-学習修正日(ISO 8601形式)

    構文

    構文例は次の通りです。

    {
        "status": {
            "code": "20000",
            "message": "OK"
    },
    "result": {
        "id": "czf9fbky",
        "name": "230821-130704",
        "model": "HCX-002",
        "method": "LoRA",
        "taskType": "GENERATION",
        "trainEpochs": 4,
        "learningRate": 1.0E-4,
        "status": "WAIT",
        "statusInfo": {
            "label": null,
            "dataRows": null,
            "numOfTokens": null,
            "currStep": null,
            "totalTrainSteps": null,
            "currEpoch": null,
            "totalTrainEpochs": null,
            "estimatedTime": null,
            "trainLoss": null,
            "sendWeightSuccess": null,
            "failureReason": null,
            "endDatetime": null
            },
            "createdClientType": "API",
            "createdDate": "2023-08-21T13:07:06+0900",
            "updatedDate": "2023-08-21T13:07:06+0900"
        }
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.