CLI Command Reference

Kakao i Machine Learning의 Kakao i Machine Learning CLI(이하 KiML CLI) 명령어입니다.
command name에 kiml 또는 km을 입력할 수 있습니다.

공공 클라우드 환경에서 CLI 설치 및 로그인하는 방법은 공공 환경 로그인 > CLI 시작하기 문서를 참고하시기 바랍니다.
KiML CLI를 안정적으로 이용하기 위해 kiml version --update 명령어를 실행하여 버전을 업데이트하시기 바랍니다.

표명령어 전체 목록

명령어	설명	별칭(aliases)	공공 클라우드 환경 제공 여부
kiml version	설치된 Kakao i Machine Learning 패키지(CLI, API) 버전을 조회
kiml context	Kakao i Machine Learning 실행 환경 관리	ctx	전체 미지원
kiml login	Kakao i Machine Learning CLI 로그인
kiml logout	Kakao i Machine Learning CLI 로그아웃
kiml applicationcredential	인증 수단인 Application Credential을 관리	ac	전체 미지원
kiml workspace	워크스페이스 관리	ws	일부 기능 미지원 - `kiml workspace create` - `kiml workspace delete`
kiml storage	스토리지 관리	st	전체 미지원
kiml data	스토리지의 데이터 관리
kiml dataset	워크스페이스의 데이터세트 관리	ds
kiml instance-type	이용 가능한 인스턴스 타입 조회	it
kiml compute-instance	컴퓨팅 인스턴스 관리	ci	전체 미지원
kiml image	이미지 관리	img
kiml experiment	실험 관리	exp
kiml run	실험의 실행을 관리
kiml model	모델 관리		전체 미지원
kiml endpoint	엔드포인트 관리	ep	전체 미지원
kiml deployment	엔드포인트의 배포 관리	dp	전체 미지원

전역으로 사용 가능한 매개 변수

일부 파라미터는 모든 명령에 사용할 수 있습니다.

표전역으로 사용 가능한 매개 변수

파라미터	필수 여부	설명
--help -h	`선택`	도움말 메시지 표시 후, 명령어는 종료됨

kiml version

설치된 KiML 패키지 버전을 조회합니다.

표kiml version 명령어 목록

명령어	설명
kiml version	KiML CLI 패키지 버전 조회

kiml version

KiML CLI와 API 버전을 조회합니다.

코드예제kiml version Syntax

Shell

kiml version [--update]
								 [--debug]

표kiml version Parameters

파라미터	타입	필수 여부	설명
--update	TEXT	`선택`	KiML CLI 버전 업데이트
--debug		`선택`	설치 진행 상황 및 설치 실패 원인 안내 - `--update` 파라미터 뒤에 입력

코드예제kiml version Sample Code

Shell

kiml version --update --debug

kiml context

CLI 패키지를 실행할 환경을 관리합니다. kiml ctx 명령어를 사용할 수 있습니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml context 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml context 명령어 목록

명령어	설명	별칭(alias)
kiml context add	접속할 수 있는 Kakao i Machine Learning 실행 환경 추가
kiml context init	Kakao i Machine Learning 환경 추가 및 이외 환경 초기화
kiml context list	저장된 Kakao i Machine Learning 실행 환경의 목록 조회	ls
kiml context set	Kakao i Machine Learning 이용 환경 설정

kiml context add

접속할 수 있는 Kakao i Machine Learning 실행 환경을 추가합니다.

코드예제kiml context add Syntax

Shell

kiml context add

kiml context init

Kakao i Machine Learning 환경을 추가하고, 이외의 환경은 초기화됩니다.

코드예제kiml context init Syntax

Shell

kiml context init

kiml context list

저장된 Kakao i Machine Learning 실행 환경의 전체 목록을 조회하고, 현재 설정된 환경을 확인합니다.

코드예제kiml context list Syntax

Shell

kiml context list

kiml context set

Kakao i Machine Learning을 실행할 환경을 설정합니다.

코드예제kiml context set Syntax

Shell

kiml context set NAME_OR_ID

표kiml context set Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	Kakao i Machine Learning 실행 환경의 이름 또는 ID

Kakao i Machine Learning CLI에 로그인하거나 로그아웃합니다.

표kiml login / logout 명령어 목록

명령어	설명
kiml login	KiML CLI 로그인
kiml logout	KiML CLI 로그아웃

Kakao i Machine Learning에 로그인하기 위해 ID와 PW를 입력합니다.

코드예제kiml login Syntax

Shell

kiml login
ID : [아이디 입력]
PW : [비밀번호 입력]

Kakao i Machine Learning 공공 클라우드 환경은 Kakao i Cloud (공공) 사용자 액세스 키를 이용하여 로그인합니다.
사용자 액세스 키 발급 방법은 Kakao i Cloud (공공) > Kakao i Cloud console > 설정 가이드의 사용자 액세스 키 사용자 가이드를 참고하시기 바랍니다.

코드예제kiml login Syntax(공공 클라우드 환경)

Shell

kiml login
ApplicationID: [사용자 액세스 ID 입력]
ApplicationSecret: [사용자 액세스 보안키 입력]

kiml logout

KiML CLI에 로그아웃되며, 인증 토큰이 즉시 만료됩니다.

코드예제kiml logout Syntax

Shell

kiml logout

kiml applicationcredential

Kakao i Machine Learning을 이용하기 위한 인증 수단 중 하나인 Application Credential을 관리합니다.
km ac 명령어도 사용할 수 있습니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml applicationcredential 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml applicationcredential 명령어 목록

파라미터	설명	별칭(alias)
kiml applicationcredential create	현재 Kakao i Machine Learning에 로그인된 사용자 정보로 Application Credential 생성
kiml applicationcredential set	Kakao i Cloud 사용자 액세스 키 등록
kiml applicationcredential delete	Application credential 삭제
kiml applicationcredential describe	Application credential 조회
kiml applicationcredential list	Application credential의 목록 조회	ls

kiml applicationcredential create

현재 Kakao i Machine Learning에 로그인된 사용자 정보로 Application Credential을 생성합니다.
ID/PW 방식으로 로그인 후, Application Credential을 생성할 수 있습니다.

계정당 최대 5개까지 생성할 수 있습니다.

코드예제kiml applicationcredential create

Shell

kiml applicationcredential create

kiml applicationcredential set

Kakao i Cloud 사용자 액세스 키를 등록하여 KiML CLI에 로그인하거나, 재로그인을 위해 CLI 로그인 정보를 변경합니다. 사용자 액세스 키가 만료되기 전까지 KiML CLI 로그인이 유지됩니다.

kiml applicationcredential delete

Application Credential을 삭제합니다.

ID/PW 방식으로 로그인 후, Application Credential을 삭제할 수 있습니다.
Application Credential 삭제 시, 발급된 토큰도 즉시 만료되어 재로그인이 필요합니다.

코드예제kiml applicationcredential delete

Shell

kiml applicationcredential delete APPLICATION_CREDENTIAL_ID

표kiml applicationcredential delete Parameters

파라미터	타입	필수 여부	설명
APPLICATION_CREDENTIAL_ID	TEXT	`필수`	삭제할 Application Credential의 ID

코드예제kiml applicationcredential delete Sample Code

Shell

kiml applicationcredential delete my-app-credential-ID

kiml applicationcredential describe

Application Credential의 정보를 조회합니다. km ac desc로도 이용할 수 있습니다.

코드예제kiml applicationcredential describe Syntax

Shell

kiml applicationcredential describe APPLICATION_CREDENTIAL_ID

표kiml applicationcredential describe Parameters

파라미터	타입	필수 여부	설명
APPLICATION_CREDENTIAL_ID	TEXT	`필수`	조회할 Application Credential의 ID

코드예제kiml applicationcredential describe Sample Code

Shell

kiml applicationcredential describe my-app-credential-ID

kiml applicationcredential list

Application Credential의 목록을 조회합니다. kiml ac ls 명령어도 사용할 수 있습니다.

코드예제kiml applicationcredential list Syntax

Shell

kiml applicationcredential list

코드예제kiml applicationcredential list Sample Code

Shell

kiml applicationcredential list

kiml instance-type

접속한 KiML 환경에서 이용 가능한 인스턴스 타입의 목록을 조회합니다.

표kiml instance-type 명령어 목록

명령어	설명
kiml instance-type	이용 가능한 인스턴스 타입 목록을 조회

kiml instance-type

접속한 KiML 환경에서 이용 가능한 인스턴스 타입의 목록을 조회합니다. km it 명령어를 사용할 수 있으며, 접속한 환경은 kiml context list를 통해 확인할 수 있습니다.

코드예제kiml instance-type Syntax

Shell

kiml instance-type

kiml workspace

워크스페이스를 관리합니다. kiml ws 명령어도 사용할 수 있습니다.

표kiml workspace 명령어 목록

파라미터	설명	별칭(alias)
kiml workspace create	워크스페이스 생성
kiml workspace delete	워크스페이스 삭제
kiml workspace add-memeber	워크스페이스의 구성원 추가	am
kiml workspace delete-member	워크스페이스 구성원의 권한 삭제 - 권한이 모두 삭제된 구성원은 워크스페이스로부터 방출	dm
kiml workspace set	기본 워크스페이스 설정
kiml workspace show	기본 워크스페이스의 정보 조회
kiml workspace update	워크스페이스 수정
kiml workspace describe	워크스페이스의 상세 정보 조회	desc
kiml workspace list	워크스페이스의 목록 조회	ls
kiml workspace list-member	로그인한 계정이 포함된 워크스페이스 목록 조회	lm
kiml workspace user-roles	사용자가 보유한 워크스페이스 권한 조회	ur

kiml workspace create

워크스페이스를 생성합니다. 생성된 워크스페이스는 CLI 명령어의 기본 워크스페이스로 변경되며, 해당 워크스페이스를 기준으로 명령어를 수행합니다. 다른 워크스페이스에서 작업하기 위해서는 --workspace 옵션을 이용하거나, kiml workspace set 명령어를 실행하여 기본 워크스페이스를 변경합니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml workspace create 명령어는 퍼블릭 환경에서만 지원합니다.

코드예제kiml workspace create Syntax

Shell

kiml workspace create NAME [--description]

표kiml workspace create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	생성할 워크스페이스 이름
--description -d	TEXT	`선택`	생성할 워크스페이스 설명

코드예제kiml workspace create Sample Code

Shell

kiml workspace create my-workspace --description "Hello, Cosmos!"

kiml workspace delete

워크스페이스를 삭제합니다. 워크스페이스 이름을 추가로 입력 후 삭제합니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml workspace delete 명령어는 퍼블릭 환경에서만 지원합니다.

코드예제kiml workspace delete Syntax

Shell

kiml workspace delete NAME_OR_ID

표kiml workspace delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	삭제할 워크스페이스의 이름 또는 ID
--force-delete		`선택`	워크스페이스 이름 재확인 없이 즉시 삭제

코드예제kiml workspace delete Sample Code

Shell

kiml workspace delete my-workspace
Workspace name : my-worksapce

kiml workspace add-member

워크스페이스의 구성원을 추가합니다. 이미 워크스페이스의 구성원인 경우, 해당 구성원이 보유하지 않은 역할을 추가할 수 있습니다. kiml ws am 명령어도 사용할 수 있습니다.

코드예제kiml workspace add-member Syntax

Shell

kiml workspace add-member USER_ID [--roletype]
														                            [--workspace]

표kiml workspace add-member Parameters

파라미터	타입	필수 여부	설명
USER_ID	TEXT	`필수`	추가할 Kakao i Machine Learning 사용자의 ID
--roletype -rt	admin \| memberc	`선택`	추가할 워크스페이스의 역할
			`admin`: 워크스페이스 관리자
			`member`: 워크스페이스 멤버 (역할을 입력하지 않을 경우, member로 추가됨)
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml workspace add-member Sample Code

Shell

kiml workspace add-member cosmos-user --roletype member

kiml workspace delete-member

워크스페이스 구성원의 역할을 삭제합니다. 역할이 모두 삭제된 구성원은 워크스페이스에서 방출됩니다. kiml ws dm 명령어도 사용할 수 있습니다.

코드예제kiml workspace delete-member Syntax

Shell

kiml workspace delete-member USER_ID [--roletype]
														                                    [--workspace]

표kiml workspace delete-member Parameters

파라미터	타입	필수 여부	설명
USER_ID	TEXT	`필수`	역할을 삭제할 구성원의 ID
--roletype -rt	admin \| member	`필수`	삭제할 역할
			`admin`: 워크스페이스 관리자
			`member`: 워크스페이스 멤버
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml workspace delete-member Sample Code

Shell

kiml workspace delete-member cosmos-user --roletype member

kiml workspace describe

워크스페이스 상세 정보를 조회할 수 있습니다.

코드예제kiml workspace describe Syntax

Shell

kiml workspace describe NAME_OR_ID

표kiml workspace describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	정보를 조회할 워크스페이스 이름 또는 ID

코드예제kiml workspace describe Sample Code

Shell

kiml workspace describe my-workspace

kiml workspace list

설정된 Kakao i Machine Learning 환경의 워크스페이스 전체 목록을 조회합니다.

코드예제kiml workspace list Syntax

Shell

kiml workspace list

kiml workspace list-member

로그인된 계정이 접근 가능한 워크스페이스 및 워크스페이스 역할(관리자/멤버) 목록을 조회합니다.

코드예제kiml workspace list-member Syntax

Shell

kiml workspace list-member

kiml workspace set

기본 워크스페이스를 설정합니다. 기본 워크스페이스 설정 시, 해당 워크스페이스를 기준으로 명령어를 수행합니다.

코드예제kiml workspace set Syntax

Shell

kiml workspace set NAME_OR_ID

표kiml workspace set Parameters

파라미터	타입	필수여부	설명
NAME_OR_ID	TEXT	`필수`	기본 워크스페이스로 설정할 워크스페이스 이름 또는 ID

코드예제kiml workspace set Sample Code

Shell

kiml workspace set my-workspace

kiml workspace show

기본 워크스페이스의 상세 정보를 조회합니다.

코드예제kiml workspace show Syntax

Shell

kiml workspace show

코드예제kiml workspace show 결과 예시

Shell

* Host                  | http://api.testbed.cosmos.k9etool.io
* Domain ID       | dummy-domain
* Project ID     | dummy-project
* Workspace 
  ├──ID                         | a1168480-182f-46b2-990b-634232d61b8b
  ├──Name                    | hello-cosmos
  └──Description   | Hello stranger! This is your first workspace for tutorial. You can also have your own workspace too.

kiml workspace update

워크스페이스 정보를 수정할 수 있습니다.

코드예제kiml workspace update Syntax

Shell

kiml workspace update NAME_OR_ID [--name]
																					 [--description]

표kiml workspace update Parameters

파라미터	타입	필수여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 워크스페이스의 이름 또는 ID
--name -n	TEXT	`선택`	워크스페이스의 새로운 이름
--description -d	TEXT	`선택`	워크스페이스의 새로운 설명

코드예제kiml workspace update Sample Code

Shell

kiml workspace update my-workspace --name kiml-workspace

kiml workspace user-roles

사용자가 보유한 워크스페이스 및 워크스페이스 역할(관리자, 멤버)을 조회합니다.

코드예제kiml workspace user-roles Syntax

Shell

kiml workspace user-roles USER_ID

표kiml workspace user-roles Parameters

파라미터	타입	필수 여부	설명
USER_ID	TEXT	`필수`	조회할 사용자의 ID

코드예제kiml workspace user-roles Sample Code

Shell

kiml workspace user-roles kiml@kakaoenterprise.com

kiml storage

스토리지를 관리합니다. km st 명령어를 사용할 수 있습니다. 스토리지에 저장된 데이터를 관리하기 위해서는 kiml data를 사용합니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml storage 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml storage 명령어 목록

파라미터	설명	별칭(alias)
kiml storage describe	스토리지 정보 조회	desc
kiml storage list	스토리지 목록 조회	ls
kiml storage update	스토리지 수정

kiml storage describe

지정된 스토리지의 정보를 조회합니다.

코드예제kiml storage describe Syntax

Shell

kiml storage describe NAME_OR_ID [--workspace]

표kiml storage describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	스토리지 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml storage describe Sample Code

Shell

kiml storage describe default

kiml storage list

설정된 Kakao i Machine Learning 환경의 스토리지 목록을 조회합니다.

코드예제kiml storage list Syntax

Shell

kiml storage list [--workspace]

표kiml storage list Parameters

파라미터	타입	필수 여부	설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

kiml storage update

스토리지를 수정합니다.

코드예제kiml storage update Syntax

Shell

kiml storage update NAME_OR_ID [--description]
															                 [--tags]
															                 [--workspace]

표kiml storage update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 스토리지 이름 또는 ID
--description -d	TEXT	`선택`	스토리지의 새로운 설명으로, 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	스토리지에 추가할 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml storage update Sample Code

Shell

kiml storage update default --description "new description" -t new-key=new-value

kiml data

스토리지의 데이터를 관리합니다. kiml data는 현재 설정된 워크스페이스를 기준으로 스토리지(원격 저장소)를 불러옵니다. 다른 워크스페이스의 스토리지 경로를 입력하기 위해서는 --workspace 옵션을 붙입니다.

표kiml data 명령어 목록

파라미터	설명	별칭(alias)
kiml data data-usage	지정된 스토리지의 사용량 조회	du
kiml data list	지정된 스토리지 경로에 저장된 데이터 목록 조회	ls
kiml data download	지정된 스토리지 경로에 저장된 데이터 다운로드
kiml data remove	지정된 스토리지 경로에 저장된 데이터 삭제
kiml data upload	지정된 스토리지 경로에 데이터 업로드

kiml data data-usage

입력받은 경로에 저장된 데이터의 크기를 조회합니다.

코드예제kiml data data-usage Syntax

Shell

kiml data data-usage STORAGE_NAME/REMOTE_PATH [--workspace]

표kiml data data-usage Parameters

파라미터	타입	필수 여부	설명
STORAGE_NAME	TEXT	`필수`	스토리지 이름 (예: default, public)
REMOTE_PATH	TEXT	`선택`	데이터 크기를 조회할 스토리지의 경로 입력
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml data data-usage Sample Code

Shell

kiml data data-usage default [--workspace]

kiml data list

지정된 스토리지 경로에 저장된 데이터 목록을 조회합니다.

코드예제kiml data list Syntax

Shell

kiml data list [STORAGE_NAME/REMOTE_PATH] [--workspace]

표kiml data list Parameters

파라미터	타입	필수 여부	설명
STORAGE_NAME	TEXT	`선택`	스토리지 이름 (예: default, public)
REMOTE_PATH	TEXT	`선택`	데이터 목록을 조회할 스토리지 경로
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml data list Sample Code

Shell

kiml data list default/notebooks

kiml data download

지정된 스토리지 경로에 저장된 데이터를 다운로드합니다.

코드예제kiml data download

Shell

kiml data download STORAGE_NAME/REMOTE_PATH LOCAL_PATH [--overwrite]
																																				[--workspace]

표kiml data download Parameters

파라미터	타입	필수 여부	설명
STORAGE_NAME	TEXT	`필수`	스토리지 이름 (예: default, public)
REMOTE_PATH	TEXT	`선택`	다운로드할 스토리지 경로 - 미입력 시 스토리지 내 데이터 전체 다운로드
LOCAL_PATH	TEXT	`필수`	데이터를 저장할 로컬 컴퓨터상의 경로
--overwrite		`선택`	로컬 컴퓨터에 중복되는 파일이 있더라도 덮어씌움
--workspace -w	TEXT	`선택`	워크스페이스 이름 혹은 ID로, 현재 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml data download Sample Code

Shell

kiml data download default/experiments ./cosmos-experiments --overwrite

kiml data remove

지정된 스토리지 경로에 저장된 데이터를 삭제합니다.

코드예제kiml data remove Syntax

Shell

kiml data remove STORAGE_NAME/REMOTE_PATH [--yes]
																							               [--workspace]

표kiml data remove Parameters

파라미터	타입	필수 여부	설명
STORAGE_NAME	TEXT	`필수`	스토리지 이름 (예: default, public)
REMOTE_PATH	TEXT	`필수`	데이터를 삭제할 스토리지 경로
--yes -y		`선택`	확인 없이 삭제
--workspace -w	TEXT	`선택`	워크스페이스 이름 혹은 ID로, 현재 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml data remove Sample Code

Shell

kiml data remove default/mnist_dataset --yes

kiml data upload

설정한 스토리지 경로에 데이터를 업로드합니다.

코드예제kiml data upload

Shell

kiml data upload LOCAL_PATH STORAGE_NAME/REMOTE_PATH [--workspace]

표kiml data upload Parameters

파라미터	타입	필수 여부	설명
LOCAL_PATH	TEXT	`필수`	업로드할 파일이 위치한 로컬 컴퓨터상의 경로
STORAGE_NAME	TEXT	`필수`	스토리지 이름 (예: default, public)
REMOTE_PATH	TEXT	`필수`	데이터를 업로드할 스토리지 경로
--workspace -w	TEXT	`선택`	데이터를 업로드할 스토리지의 워크스페이스 이름 또는 ID - default 스토리지일 경우 입력 - 현재 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml data upload Sample Code

Shell

kiml data upload ./mnist_dataset public/mnist_dataset

kiml dataset

워크스페이스의 데이터세트를 관리합니다. km ds명령어도 사용할 수 있습니다.

표kiml dataset 명령어 목록

파라미터	설명	별칭(alias)
kiml dataset create	데이터세트 생성
kiml dataset delete	데이터세트 삭제
kiml dataset describe	데이터세트의 정보 조회	desc
kiml dataset list	데이터세트의 목록 조회	ls
kiml dataset update	데이터세트 수정

kiml dataset create

데이터세트를 생성합니다.

코드예제kiml dataset create Syntax

Shell

kiml dataset create NAME [--description]
											              	  [--path]
											              	  [--tags]
											              	  [--workspace]

표kiml dataset create Parameters

파라미터	타입	필수 여부	설명
Name	TEXT	`필수`	데이터세트 이름
--description -d	TEXT	`선택`	데이터세트 설명
--path	TEXT	`필수`	데이터세트가 저장된 원격 저장소 경로
--tags -t	TEXT	`선택`	데이터세트 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml dataset create Sample Code

Shell

kiml dataset create my-dataset --path default/mnist_dataset --description dummy

kiml dataset delete

데이터세트를 삭제합니다.

코드예제kiml dataset delete Syntax

Shell

kiml dataset delete NAME_OR_ID [--workspace]
																		      [--yes]

표kiml dataset delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	데이터세트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행
--yes -y		`선택`	확인 없이 삭제

코드예제kiml dataset delete Sample Code

Shell

kiml dataset delete my-dataset --workspace my-workspace

kiml dataset describe

데이터세트 정보를 조회합니다.

코드예제kiml dataset describe Syntax

Shell

kiml dataset describe NAME_OR_ID [--workspace]

표kiml dataset describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	데이터세트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어를 실행

코드예제kiml dataset describe Sample Code

Shell

kiml dataset describe my-dataset --workspace my-workspace

kiml dataset list

워크스페이스에 생성된 데이터세트 목록을 조회합니다.

코드예제kiml dataset list Syntax

Shell

kiml dataset list [--workspace]

표kiml dataset list Parameters

파라미터	타입	필수 여부	설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml dataset list Sample Code

Shell

kiml dataset list --workspace my-workspace

kiml dataset update

데이터세트를 수정합니다.

코드예제kiml dataset update Syntax

Shell

kiml dataset update NAME_OR_ID [--description]
																				[--tags]
																				[--workspace]

표kiml dataset update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 데이터세트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행
--description -d	TEXT	`선택`	데이터세트의 새로운 설명으로 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	데이터세트 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`

코드예제kiml dataset update Sample Code

Shell

kiml dataset update my-dataset --workspace my-workspace -d "new description of my-dataset"

kiml compute-instance

컴퓨팅 인스턴스를 관리합니다. km ci 명령어를 사용할 수 있습니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml compute-instance 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml compute-instance 명령어 목록

파라미터	설명	별칭(alias)
kiml compute-instance create	컴퓨팅 인스턴스 생성
kiml compute-instance delete	컴퓨팅 인스턴스 삭제
kiml compute-instance start	컴퓨팅 인스턴스 시작
kiml compute-instance stop	컴퓨팅 인스턴스 정지
kiml compute-instance exec	컴퓨팅 인스턴스 접속
kiml compute-instance lab	컴퓨팅 인스턴스 JupyterLab 실행
kiml compute-instance update	컴퓨팅 인스턴스 수정
kiml compute-instance list	컴퓨팅 인스턴스 목록 조회	ls
kiml compute-instance describe	컴퓨팅 인스턴스 상세 정보 조회	desc

kiml compute-instance create

컴퓨팅 인스턴스를 생성합니다.

코드예제kiml compute-instance create Syntax

Shell

kiml compute-instance create NAME [--image]
																						[--instance-type]
																						[--description]
																						[--tags]
																						[--workspace]

표kiml compute-instance create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	생성할 컴퓨팅 인스턴스 이름
--image -img	TEXT	`필수`	이미지 이름
--instance-type -it	TEXT	`필수`	인스턴스 타입
--description -d	TEXT	`선택`	컴퓨팅 인스턴스 설명
--tags -t	TEXT	`선택`	컴퓨팅 인스턴스 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance create Sample Code

Shell

kiml compute-instance create my-compute-instance \
--image cosmos-pytorch1.11.0-cuda11.3-cudnn8-py3.8-ubuntu18.04 \
--instance-type 1V100-12-MO

kiml compute-instance delete

컴퓨팅 인스턴스를 삭제합니다.

코드예제kiml compute-instance delete Syntax

Shell

kiml compute-instance delete NAME_OR_ID [--workspace]
																									   [--yes]

표kiml compute-instance delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	삭제할 컴퓨팅 인스턴스 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행
--yes		`선택`	확인 없이 삭제

코드예제kiml compute-instance delete Sample Code

Shell

kiml compute-instance delete my-compute-instance

kiml compute-instance describe

컴퓨팅 인스턴스의 상세 정보를 조회합니다. km ci desc 명령어를 사용할 수 있습니다.

코드예제kiml compute-instance describe Syntax

Shell

kiml compute-instance describe NAME_OR_ID [--workspace]

표kiml compute-instance describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	정보를 조회할 컴퓨팅 인스턴스 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance describe Sample Code

Shell

kiml compute-instance describe my-compute-instance

kiml compute-instance exec

컴퓨팅 인스턴스에 접속합니다. Running 상태의 인스턴스만 접속 가능합니다.

코드예제kiml compute-instance exec Syntax

Shell

kiml compute-instance exec NAME_OR_ID [--wait]
																								[--workspace]

표kiml compute-instance exec Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	컴퓨팅 인스턴스 이름 또는 ID
--wait		`선택`	컴퓨팅 인스턴스 생성이 완료될 때까지 기다린 후 접속
--wait		`선택`	`false`(기본값): 생성이 완료되지 않았다면 접속 시도 중단
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance exec Sample Code

Shell

kiml compute-instance exec my-compute-instance

kiml compute-instance lab

컴퓨팅 인스턴스에 JupyterLab을 실행하고 접속합니다.

코드예제kiml compute-instance lab Syntax

Shell

kiml compute-instance lab NAME_OR_ID [--wait]
																								[--workspace]

표kiml compute-instance lab Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	컴퓨팅 인스턴스 이름 또는 ID
--wait		`선택`	컴퓨팅 인스턴스 생성이 완료될 때까지 기다린 후 접속
--wait		`선택`	`false`(기본값): 생성이 완료되지 않았다면 접속 시도 중단
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance lab Sample Code

Shell

kiml compute-instance lab my-compute-instance

kiml compute-instance list

컴퓨팅 인스턴스의 목록을 조회합니다. km ci ls 명령어를 사용할 수 있습니다.

코드예제kiml compute-instance list Syntax

Shell

kiml compute-instance list [--workspace]

표kiml compute-instance list Parameters

파라미터	타입	필수 여부	설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance list Sample Code

Shell

kiml compute-instance list

kiml compute-instance start

정지 상태에 있는 컴퓨팅 인스턴스를 동작시킵니다.

코드예제kiml compute-instance start Syntax

Shell

kiml compute-instance start NAME_OR_ID [--workspace]

표kiml compute-instance start Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	컴퓨팅 인스턴스 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance start Sample Code

Shell

kiml compute-instance start my-compute-instance

kiml compute-instance stop

동작 상태에 있는 컴퓨팅 인스턴스를 정지시킵니다.

코드예제kiml compute-instance stop Syntax

Shell

kiml compute-instance stop NAME_OR_ID [--workspace]

표kiml compute-instance stop Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	컴퓨팅 인스턴스 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance stop Sample Code

Shell

kiml compute-instance stop my-compute-instance

kiml compute-instance update

컴퓨팅 인스턴스를 수정합니다. Stopped 또는 Failed 상태의 컴퓨팅 인스턴스만 수정할 수 있습니다.

코드예제kiml compute-instance update Syntax

Shell

kiml compute-instance update NAME_OR_ID [--instance-type]
																										[--description]
																										[--tags]
																										[--workspace]

표kiml compute-instance update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 컴퓨팅 인스턴스 이름 또는 ID
--instance-type -it	TEXT	`선택`	컴퓨팅 인스턴스를 구성할 인스턴스의 타입 이름 - 접속한 환경에서 이용 가능한 인스턴스 타입은 `kiml instance-type`에서 확인 가능함
--description -d	TEXT	`선택`	컴퓨팅 인스턴스의 새로운 설명으로, 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	컴퓨팅 인스턴스 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml compute-instance update Sample Code

Shell

kiml compute-instance update my-compute-instance --instance-type "1V100-12-MO"

kiml image

기본 이미지(base image)를 조회하고, 커스텀 이미지(custom image)를 관리합니다.

표kiml image 명령어 목록

파라미터	설명	별칭(alias)
kiml image create	Docker Image 주소 또는 Python 패키지 목록으로 커스텀 이미지 생성
kiml image delete	이미지 삭제	del
kiml image describe	이미지 정보 조회	desc
kiml image list	이미지 목록 조회	ls
kiml image logs	이미지 빌드 로그 조회
kiml image update	이미지 업데이트

kiml image create

Docker Image 주소(docker-image-path) 또는 Python 패키지를 설치(requirements-file)하는 방법을 선택하여 커스텀 이미지를 생성합니다.

코드예제kiml image create Syntax

Shell

kiml image create [--name]
											[--description]
											[--docker-image-path]
											[--registry-id]
											[--registry-pw]
											[--requirements-file]
											[--base-image-name]
											[--tags]
											[--workspace]

표kiml image create Parameters

파라미터	타입	필수 여부	설명
--name -n	TEXT	`필수`	커스텀 이미지 이름
--description -d	TEXT	`선택`	커스텀 이미지 설명
--docker-image-path	TEXT	`선택`	커스텀 이미지 생성 방법: Docker Image 불러오기 - Docker Image 경로
--registry-id -id	TEXT	`선택`	Docker image의 경로 접근 시 사용할 사용자 인증 정보의 ID - 비공개 리포지터리인 경우 입력
--registry-pw -pw	TEXT	`선택`	Docker image의 경로 접근 시 사용할 사용자 인증 정보의 비밀번호 - 비공개 리포지터리인 경우 입력
--requirements-file -rf	TEXT	`선택`	커스텀 이미지 생성 방법: Python 패키지 설치 - 요구하는 Python 패키지의 목록이 저장된 경로
--base-image-name -b	TEXT	`선택`	`requirements-file` 방법을 선택한 경우, 새로운 이미지를 구성하기 위해 사용할 준비 이미지의 이름 입력 - 기본 이미지 또는 `Python Requirements File` 타입 및 `Succeeded` 상태의 커스텀 이미지만 가능
--tags -t	TEXT	`선택`	커스텀 이미지 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml image create Sample Code (생성 방법: docker image)

Shell

kiml image create \
--name mnist-image \
--docker-image kiml-gov.kr-gov-central-1.kcr.dev/public-kiml/cosmos-tensorflow2.8.0-cuda11.2-cudnn8-py3.8-ubuntu20.04

코드예제kiml image create Sample Code (생성 방법: pip requirements)

Shell

kiml image create \
--name mnist-image \
--requirements-file ./requirements.txt \
--base-image-name cosmos-pytorch1.11.0-cuda11.3-cudnn8-py3.8-ubuntu18.04

kiml image delete

커스텀 이미지를 삭제합니다. km img del 명령어를 사용할 수 있습니다.

코드예제kiml image delete Syntax

Shell

kiml image delete NAME_OR_ID [--workspace]
																		 [--yes]

표kiml image delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	커스텀 이미지 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행
--yes -y		`선택`	확인 없이 삭제

코드예제kiml image delete Sample Code

Shell

kiml image delete mnist-image

kiml image describe

이미지 정보를 조회합니다. km img desc 명령어를 사용할 수 있습니다.

코드예제kiml image describe Syntax

Shell

kiml image describe NAME_OR_ID [--workspace]

표kiml image describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	이미지 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml image describe Sample Code

Shell

kiml image describe mnist-image

kiml image list

워크스페이스에 커스텀 이미지 목록을 조회합니다. km img ls 명령어를 사용할 수 있습니다.

코드예제kiml image list Syntax

Shell

kiml image list [--no-base-image]
								      [--workspace]

표kiml image list Parameters

파라미터	타입	필수 여부	설명
--no-base-image		`선택`	기본 이미지를 목록 결과에서 숨김
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml image list Sample Code

Shell

kiml image list

kiml image logs

커스텀 이미지 빌드 로그를 조회합니다. km img log 명령어를 사용할 수 있습니다.

코드예제kiml image logs Syntax

Shell

kiml image logs NAME_OR_ID [--follow]
																	[--since]
																	[--tail]
																	[--workspace]

표kiml image logs Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	커스텀 이미지 이름 또는 ID
--follow -f		`선택`	로그를 실시간으로 조회
--since	Integer	`선택`	현재 시점 기준으로 n초 전까지 발생한 로그 조회(단위: 초) - 예) 3600
--tail	Integer	`선택`	마지막 로그에서 입력한 숫자 N번째 줄의 로그까지 조회
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml image logs Sample Code

Shell

kiml image logs mnist-image --follow

kiml image update

커스텀 이미지를 수정합니다.

코드예제kiml image update Syntax

Shell

kiml image update NAME_OR_ID [--description]
																		 [--tags]
																		 [--workspace]

표kiml image update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	커스텀 이미지 이름 또는 ID
--descripton -d	TEXT	`선택`	커스텀 이미지의 새로운 설명으로, 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	커스텀 이미지 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml image update Sample Code

Shell

kiml image update mnist-image --description dummy

kiml experiment

워크스페이스의 실험을 관리합니다. km exp 명령어를 사용할 수 있습니다.

표kiml experiment 명령어 목록

파라미터	설명	별칭(alias)
kiml experiment create	실험 생성
kiml experiment delete	실험 삭제	del
kiml experiment describe	실험 정보 조회	desc
kiml experiment list	실험 목록 조회	ls
kiml experiment tensorboard	실험의 TensorBoard로 이동
kiml experiment update	실험 수정

kiml experiment create

실험을 생성합니다.

코드예제kiml experiment create Syntax

Shell

kiml experiment create NAME [--description]
														              [--workspace]

표kiml experiment create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	실험의 이름
--description -d	TEXT	`선택`	실험의 설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml experiment create Sample Code

Shell

kiml experiment create my-experiment --description dummy

kiml experiment delete

실험을 삭제합니다.

코드예제kiml experiment delete Syntax

Shell

kiml experiment delete NAME_OR_ID [--workspace]
																						[--yes]

표kiml experiment delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실험 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행
--yes -y		`선택`	확인 없이 삭제

코드예제kiml experiment delete Sample Code

Shell

kiml experiment delete my-experiment [--yes]

kiml experiment describe

실험 정보를 조회합니다.

코드예제kiml experiment describe Syntax

Shell

kiml experiment describe NAME_OR_ID [--workspace]

표kiml experiment describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실험 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml experiment describe Sample Code

Shell

kiml experiment describe my-experiment [--workspace]

kiml experiment list

실험 목록을 조회합니다.

코드예제kiml experiment list Syntax

Shell

kiml experiment list [--workspace]

표kiml experiment list Parameters

파라미터	타입	필수 여부	설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml experiment list Sample Code

Shell

kiml experiment list [--workspace]

kiml experiment tensorboard

실험의 TensorBoard로 이동합니다.

코드예제kiml experiment tensorboard Syntax

Shell

kiml experiment tensorboard NAME_OR_ID [--workspace]

표kiml experiment tensorboard Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실험 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 현재 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml experiment tensorboard Sample Code

Shell

kiml experiment tensorboard my-experiment [--workspace]

kiml experiment update

실험을 수정합니다.

코드예제kiml experiment update Syntax

Shell

kiml experiment update NAME_OR_ID [--description]
																						[--tags]
																						[--workspace]

표kiml experiment update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실험 이름 또는 ID
--description -d	TEXT	`선택`	실험의 새로운 설명으로, 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	실험 추가 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 현재 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml experiment update Sample Code

Shell

kiml experiment update my-experiment --description "new description"

kiml run

실험의 실행을 관리합니다.

표kiml run 명령어 목록

파라미터	설명
kiml run submit	실행 제출
kiml run delete	실행 삭제
kiml run describe	실행 정보 조회
kiml run exec	실행 환경 접속
kiml run list	실행 목록 조회
kiml run logs	실행 로그 조회
kiml run stop	실행 정지
kiml run update	실행 수정

kiml run submit

학습하기 위해 실행을 생성하고 제출합니다. SCRIPT 명령어에 Shell 스크립트와 cmd를 입력하여, 해당 스크립트를 동작할 수 있습니다. 단, Python 또는 torchRun만 실행 가능합니다.

코드예제kiml run submit Syntax

Shell

kiml run submit SCRIPT [--source-directory]
										               [--dataset]
										               [--instance-type]
										               [--num-replica]
										               [--image]
										               [--name]
										               [--description]
										               [--env-var]
										               [--tag]
										               [--experiment]
										               [--workspace]
										               [--wait-for-completion]

표kiml run submit Parameters

파라미터	타입	필수 여부	설명
SCRIPT	TEXT	`필수`	실행을 수행하기 위한 스크립트 - 스크립트에 argument를 전달할 경우에는 `--` 문자를 삽입한 뒤 기입
--source-directory	TEXT	`선택`	소스코드 디렉토리 경로 - 기본값: `pwd`
--dataset	TEXT	`선택`	데이터세트의 이름 - 입력한 데이터세트는 `/app/input/dataset/{데이터세트 이름}`의 위치에 마운트되며, 학습 실행 중 접근 가능함
--instance-type -it	TEXT	`필수`	인스턴스 타입
--num-replica	Integer	`선택`	인스턴스 개수 - 기본값: `1`
--image -img	TEXT	`필수`	이미지 이름
--name -n	TEXT	`선택`	실행 이름 - 해당 워크스페이스에서 실행 이름이 고유해야함 (중복 불가)
--description	TEXT	`선택`	실행 설명
--env-var	TEXT	`선택`	환경변수 예) `EPOCH=3`
--tag	TEXT	`선택`	태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로 추가함 예) `-t k1=v1`, `-t k2=v2`
--experiment -e	TEXT	`필수`	실행을 포함할 실험 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용
--wait-for-completion -f		`선택`	학습이 완료될 때까지 학습 로그를 조회 - 기본값: 학습 로그 미조회

코드예제kiml run submit Sample Code

Shell

kiml run submit --dataset mnist-dataset --experiment mnist-experiment --image cosmos-pytorch1.10.0-cuda11.3-cudnn8-py3.7-ubuntu18.04 --instance-type ${instance_type} --num-replica 1 --source-directory ./src "python mnist.py --data_dir /app/input/dataset/mnist-dataset --output_dir /app/outputs"

kiml run delete

실행을 삭제합니다. km run del 명령어를 사용할 수 있습니다.

코드예제kiml run delete Syntax

Shell

kiml run delete NAME_OR_ID [--workspace]
																	 [--yes]

표kiml run delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실행 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용
--yes -y		`선택`	확인 없이 삭제

코드예제kiml run delete Sample Code

Shell

kiml run delete mnist-run

kiml run describe

실행 정보를 조회합니다. km run desc 명령어를 사용할 수 있습니다.

코드예제kiml run describe Syntax

Shell

kiml run describe NAME_OR_ID [--experiment]
																		 [--workspace]

표kiml run describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실행 이름 또는 ID
--experiment -e	TEXT	`선택`	실험 이름 또는 ID로, 설정되지 않은 실험을 지정할 때 사용
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용

미지원 기능 안내
공공 클라우드 환경에서는 실행 로그를 조회할 수 있는 Kibana 주소는 지원하지 않습니다.

코드예제kiml run describe Sample Code

Shell

kiml run describe mnist-run dummy

코드예제kiml run describe 결과 화면

Shell

* ID                  | e4sd9363-0bf9-433e-b4d4-e39c42685f3a
* Name                | mnist run
* Description         | mnist 모델입니다.
* Tags                | 
* Status              | Completed
* Experiment          | mnist-experiment
* Image               | 79acfcbe-4484-4dda-9135-1adeec734a6b
* Resource Flavor     | 1A100-12-MO
* Replicas            | 1
* Log Url             | //공공 클라우드 환경에서 미지원
* Command             | torchrun --nproc_per_node=$GPU_COUNT --node_rank=$RANK --nnodes=$WORLD_SIZE --master_addr=$MASTER_ADDR --master_port=$MASTER_PORT train.py --data_dir /app/input/dataset/pytorch-dataset --output_dir /app/outputs
* Compute Started At  | 2023-04-09T14:31:56+09:00
* Compute Finished At | 2023-04-09T14:36:43+09:00
* Compute Duration    | 4m47s
* Output Directory    | experiments/3a47bd79-bc78-460b-b81c-49c7292efab0/runs/mnist-run/outputs
* Created At          | 2023-04-09T14:31:52+09:00
* Last Modified At    | 2023-04-09T14:55:10+09:00

kiml run exec

실행 환경에 접속하여 디버깅 등의 작업이 가능합니다. Running 상태의 실행만 접속할 수 있습니다.

코드예제kiml run exec Syntax

Shell

kiml run exec NAME_OR_ID [--workspace]

표kiml run exec Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실행 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml run exec Sample Code

Shell

kiml run exec mnist-run [--experiment]

kiml run list

실행 목록을 조회합니다. km run ls 명령어를 사용할 수 있습니다.

코드예제kiml run list Syntax

Shell

kiml run list [--experiment]
								  [--workspace]

표kiml run list Parameters

파라미터	타입	필수 여부	설명
--experiment -e	TEXT	`선택`	실험 이름 또는 ID로, 설정되지 않은 실험을 지정할 때 사용
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml run list Sample Code

Shell

kiml run list mnist-run [--experiment]

kiml run logs

실행 로그를 조회합니다. km run log 명령어를 사용할 수 있습니다.

코드예제kiml run logs Syntax

Shell

kiml run logs NAME_OR_ID [--follow]
															  [--since]
															  [--tail]
															  [--workspace]

표kiml run logs Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	실행 이름 또는 ID
--follow -f		`선택`	로그를 실시간으로 조회
--since	Integer	`선택`	현재 시점 기준 n초 전까지의 로그 조회(단위: 초) - 예) 3600
--tail	Integer	`선택`	마지막 로그부터 입력받은 숫자 만큼의 로그를 조회 - 기본값: `all`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml run logs Sample Code

Shell

kiml run logs mnist-run --follow

kiml run stop

작업 중인 실행을 정지합니다.

코드예제kiml run stop Syntax

Shell

kiml run stop NAME_OR_ID

표kiml run stop Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	정지할 실행 이름 또는 ID

kiml run update

실행을 수정합니다.

코드예제kiml run update Syntax

Shell

kiml run update NAME_OR_ID [--description]
																	[--tags]
																	[--workspace]

표kiml run update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 실행 이름 또는 ID
--description -d	TEXT	`선택`	실행의 새로운 설명으로, 기존의 값을 덮어씀
--tags -t	TEXT	`선택`	실행에 추가할 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정할 경우 지정된 워크스페이스에서 명령어 실행

코드예제kiml run update Sample Code

Shell

kiml run update mnist-run --description "my new description"

kiml model

모델을 생성하거나 삭제하고 관리합니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml model 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml model 명령어 목록

파라미터	설명	별칭 alias
kiml model create	모델 생성
kiml model delete	모델 삭제	del
kiml model describe	모델 정보 조회	desc
kiml model list	모델 목록 조회	ls

kiml model create

모델을 생성하거나, 등록된 모델에 버전을 추가할 수 있습니다.

코드예제kiml model create Syntax

Shell

kiml model create NAME
									        [--alias]
									        [--experiment]
									        [--run]
									        [--path]
									        [--upload]
									        [--storage-path]
									        [--description]
									        [--workspace]
									        [--yes]

표kiml model create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	모델 이름
--alias -as	TEXT	`선택`	모델 별칭
--experiment	TEXT	`선택`	모델을 등록할 실험 이름
--run	TEXT	`선택`	모델을 등록할 실행 이름
--path	TEXT	`선택`	학습의 결과로 저장한 모델의 위치 - prefix로 실행의 아웃풋 경로가 입력되므로, 아무런 값을 입력하지 않을 경우 실행의 아웃풋 위치가 자동으로 지정됨 - 실행의 아웃풋 경로: `experiments/${experiment-id}/runs/${run-name}/outputs`
--upload	TEXT	`선택`	로컬에 저장된 파일을 업로드 한 뒤 모델로 지정함 - 업로드한 모델 파일은 기본 원격저장소의 models 하위에 저장됨 예) `--upload /src/model.pt`
--storage-path	TEXT	`선택`	원격 저장소에 저장된 폴더 경로를 모델로 지정함 예) `--storage-path default/models/${model-name}`
--description -d	TEXT	`선택`	모델 설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용
--yes -y		`선택`	입력한 모델 이름이 존재하는 경우, 모델 버전이 자동으로 추가됨

코드예제kiml model create Sample Code

Shell

kiml model create mnist-model \
--experiment mnist-experiment \
--run mnist-run

kiml model delete

모델을 삭제합니다. km del 명령어를 사용할 수 있습니다.

코드예제kiml model delete Syntax

Shell

kiml model delete NAME_OR_ID [--yes]
																		 [--workspace]
																		 [--version]
																		 [--all-versions]

표kiml model delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	모델 이름 또는 ID
--yes -y		`선택`	확인 없이 삭제
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함
--version -v	Integer	`선택`	모델 버전을 삭제
--all-versions -A		`선택`	모델의 모든 버전을 삭제

코드예제kiml model delete Sample Code

Shell

kiml model delete mnist-model [--yes]

kiml model describe

모델 정보를 조회합니다.

코드예제kiml model describe Syntax

Shell

kiml model describe NAME_OR_ID [--workspace]
																				[--version]

표kiml model describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	모델 이름 또는 ID
--version -v	Integer	`선택`	모델 버전
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml model describe Sample Code

Shell

kiml model describe mnist-model [--workspace]

kiml model list

워크스페이스의 모델 목록을 조회합니다.

코드예제kiml model list Syntax

Shell

kiml model list [--workspace]
										[--latest]

표kiml model list Parameters

파라미터	타입	필수 여부	설명
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함
--latest -l		`선택`	최신 버전의 모델만 조회

kiml endpoint

엔드포인트를 관리합니다. km ep 명령어를 사용할 수 있습니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml endpoint 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml endpoint 명령어 목록

파라미터	설명	별칭(alias)
kiml endpoint create	엔드포인트 생성
kiml endpoint delete	엔드포인트 삭제	del
kiml endpoint describe	엔드포인트 정보 조회	desc
kiml endpoint list	엔드포인트 정보 조회	ls
kiml endpoint reissue-key	엔드포인트 API Key 재발급	rk

kiml endpoint create

엔드포인트를 생성합니다.

코드예제kiml endpoint create Syntax

Shell

kiml endpoint create NAME
					                            [--description]
					                            [--tags]
					                            [--workspace]

표kiml endpoint create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	엔드포인트 이름
--description -d	TEXT	`선택`	엔드포인트 설명
--tags -t	TEXT	`선택`	태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml endpoint create Sample Code

Shell

kiml endpoint create mnist-endpoint

kiml endpoint delete

엔드포인트를 삭제합니다.

코드예제kiml endpoint delete Syntax

Shell

kiml endpoint delete NAME_OR_ID [--workspace]
																				 [--yes]

표kiml endpoint delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	엔드포인트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함
--yes -y	TEXT	`선택`	확인 없이 삭제

코드예제kiml endpoint delete Sample Code

Shell

kiml endpoint delete mnist-endpoint

kiml endpoint describe

엔드포인트 정보를 조회합니다.

코드예제kiml endpoint describe Syntax

Shell

kiml endpoint describe NAME_OR_ID [--workspace]

표kiml endpoint describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	엔드포인트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml endpoint describe Sample Code

Shell

kiml endpoint describe mnist-endpoint

코드예제kiml endpoint describe 결과 화면

Shell

* ID                          | ac9457b6-a9f3-4d41-bc47-40208e1e7378
* Name                     | mnist-endpoint
* Deployments    | mnist-deployment
* URL                        | f166ca98-d0e6-43bb-8dfa-bc30d1587aa2.endpoint.production.ml.k9etool.io/latest/api
* API Key                | fe06b3ba-a7e8-419c-af31-f6e84a81c034-ac9457b6-a9f3-4d41-bc47-40208e1e7378.34aa0e2c761ddf5a253df30529dac41bb128e735af4d8afdf2571sdfss94a
* Description    |
* Tags                      |
* Created At        | 2022-10-21T19:55:28+09:00

kiml endpoint list

엔드포인트 목록를 조회합니다.

코드예제kiml endpoint list Syntax

Shell

kiml endpoint list [--workspace]

kiml endpoint reissue-key

엔드포인트 API Key를 재발급합니다.

코드예제kiml endpoint reissue-key Syntax

Shell

kiml endpoint reissue-key NAME_OR_ID [--workspace]

표kiml endpoint reissue-key Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	엔드포인트 이름 또는 ID
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml endpoint reissue-key Sample Code

Shell

kiml endpoint reissue-key my-mnist-endpoint

kiml deployment

엔드포인트 배포를 관리합니다.

공공 클라우드 환경 미지원 안내
카카오 i 머신러닝 운영 환경(퍼블릭/공공)에 따라 제공하는 기능이 다를 수 있습니다. kiml deployment 명령어는 퍼블릭 환경에서만 지원합니다.

표kiml deployment 명령어 목록

파라미터	설명	별칭(alias)
kiml deployment create	배포 생성
kiml deployment delete	배포 삭제	del
kiml deployment describe	배포의 정보 조회	desc
kiml deployment list	배포의 목록 조회	ls
kiml deployment logs	배포의 로그 조회	log
kiml deployment restart	배포 재시작
kiml deployment update	배포 수정

kiml deployment create

엔드포인트에 배포를 생성합니다.

코드예제kiml deployment create Syntax

Shell

kiml deployment create NAME [--endpoint]
																		[--serving-framework]
																		[--num-replica]
																		[--instance-type]
																		[--image]
																		[--cluster]
																		[--port]
																		[--mirror]
																		[--traffic-weight]
																		[--model-spec]
																		[--tfserving]
																		[--triton]
																		[--cmserving-github]
																		[--cmserving-code]
																		[--protocol]
																		[--readiness]
																		[--liveness]                                                                        
																		[--envs]
																		[--description]
																		[--tags]
																		[--workspace]

표kiml deployment create Parameters

파라미터	타입	필수 여부	설명
NAME	TEXT	`필수`	배포 이름
--endpoint -ep	TEXT	`필수`	엔드포인트 이름
--serving-framework -sf	TEXT	`필수`	생성할 배포의 종류 - 입력 가능한 프레임워크 종류 `tfserving`: TensorFlow Serving `triton`: Trition `cmserving`: Kakao i Machine Learning Serving `custom`: Custom Image
--num-replica -nr	Integer	`필수`	인스턴스 개수
--instance-type -it	TEXT	`필수`	인스턴스 타입
--image -img	TEXT	`필수`	이미지
--cluster -c	TEXT	`필수`	배포가 생성될 클러스터 - Testbed 환경: `testbed` 입력
--port	Integer	`선택`	포트 번호 - `custom` 배포 타입은 입력 필요, 미입력 시 `8080`으로 처리 - 그 외 배포 타입은 자동 처리하므로 해당 없음
--mirror	Boolean	`선택`	미러링 모드 -미러를 할 배포에 입력 - `true`: 미러링 모드 사용 - `false`: 미러링 모드 미사용
--traffic-weight	Integer	`선택`	엔드포인트에 인입되는 트래픽을 배포로 분산시키는 가중치 - Canary 배포를 위해 배포가 2개인 경우, 트래픽 비율 입력 - 배포별 트래픽 비율 설정을 위한 0~100 사이의 숫자 입력 - 예) 50
	TEXT	`선택`	배포할 모델 정보
-ms name	TEXT	`선택`	배포할 모델 이름
-ms version	Integer	`선택`	배포할 모델 버전
-ms mountPath	TEXT	`선택`	배포할 모델 경로 (Upload로 생성한 모델일 경우)
	TEXT	`선택`	`tfserving`을 위한 옵션 플래그
-tf allowedBatchSizes=	TEXT	`선택`	배치 작업이 동시에 처리될 배열 - 대기열 및 쉼표(`,`)로 입력 - allowedBatchSizes의 입력값 중 최댓값은 maxBatchSize와 일치해야 함 - 예) “1, 16, 32, 64, 128”
-tf maxBatchSize=128	Integer	`선택`	배치 최대 크기
-tf batchTimeOut=10000	Integer	`선택`	배치 타임아웃 (단위: 초) - 입력한 시간을 초과한 경우, 배치가 자동으로 종료됨
-tf maxEnqueuedBatches=10	Integer	`선택`	대기열에 추가할 최대 배치 크기
-tf numBatchThreads=1	Integer	`선택`	동시에 처리할 수 있는 배치 단위
	TEXT	`선택`	`triton`을 위한 옵션 플래그
-tr config=config.pbtxt	TEXT	`선택`	JSON에 명시된 모델 구성 정보 - 사전에 config.pbtxt 파일 생성 필요
	TEXT	`선택`	배포 타입을 `cmserving`으로 선택한 경우, GitHub으로 불러오기
-cs github={github url}	TEXT	`선택`	사용자 스크립트를 불러올 GitHub 주소 - GitHub Enterprise는 별도 작업 필요 예) `https://github.com/kiml/example.git`
-cs branch={branch name}	TEXT	`선택`	사용자 스크립트를 불러올 GitHub 주소 브랜치 -입력하지 않을 경우, 설정된 default 브랜치 불러옴
	TEXT	`선택`	배포 타입을 `cmserving`으로 선택한 경우, 스크립트 직접 불러오기
-cs entrypoint=		`선택`	Python을 최초로 실행할 Entrypoint
-cs requirements=		`선택`	Python 설치 패키지 Requirements
--protocol	TEXT	`선택`	배포 프로토콜 설정: `HTTP` 또는 `gRPC` - 파라미터 미입력 시 `HTTP`으로 설정됨 - 대소문자 구분 없음
	TEXT	`선택`	배포타입 ‘커스텀 이미지’인 경우, 배포 인스턴스 헬스체크를 위한 준비 상태 조건 설정(그 외 배포타입은 자동 설정) - 커스텀 이미지에 설정한 포트 번호로 연결 시도
-type	TEXT	`선택`	준비 상태 Probe 입력 (1개만 설정 가능) - `httpGet` 또는 `tcpSocket` 입력
-path	TEXT	`선택`	readiness API 경로 입력 - 기본값: `/`
-periodSeconds	Integer	`선택`	호출 간격 입력 (단위: 초) - 입력 가능 범위: 1~999999
-failureThreshold	Integer	`선택`	호출 실패 허용 횟수 입력 (단위: 회) - 입력 가능 범위: 1~999999
	TEXT	`선택`	배포타입 ‘커스텀 이미지’인 경우, 배포 인스턴스 헬스체크를 위한 활성 상태 조건 설정 (그 외 배포타입은 자동 설정) - 커스텀 이미지에 설정한 포트 번호로 연결 시도
-type	TEXT	`선택`	준비 상태 Probe 입력 (1개만 설정 가능) - `httpGet` 또는 `tcpSocket` 입력
-path	TEXT	`선택`	liveness API 경로 입력 - 기본값: `/`
-periodSeconds	Integer	`선택`	호출 간격 입력 (단위: 초) - 입력 가능 범위: 1~999999
-failureThreshold	Integer	`선택`	호출 실패 허용 횟수 입력 (단위: 회) - 입력 가능 범위: 1~999999
--envs	TEXT	`선택`	배포 환경변수 설정 예) `--envs k1=v1`, `--envs k2=v2`
--description -d	TEXT	`선택`	배포 설명
--tags -t	TEXT	`선택`	배포 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml deployment create Sample Code (배포 타입: Trition)

Shell

kiml deployment create mnist-deployment \
--endpoint mnist-endpoint \
--serving-framework triton \
--instance-type ${instance_type} \
--num-replica 1 \
--image cosmos-tritonserver-22.06-py3 \
--cluster ${cluster_name} \
--model-spec name=mnist-model \
--triton config=config.pbtxt

코드예제kiml deployment create Sample Code (배포타입: TensorFlow Serving)

Shell

kiml deployment create mnist-deployment \
--endpoint mnist-endpoint \
--serving-framework tfserving \
--instance-type ${instance_type} \
--num-replica 1 \
--image cosmos-tfserving-2.5.4 \
--cluster ${cluster_name} \
--model-spec name=test-model

코드예제kiml deployment create Sample Code (배포타입: Cosmos Serving)

Shell

kiml deployment create ${deployment_name} \
--endpoint ${endpoint_name} \
--serving-framework cmserving \
--num-replica 1 \
--instance-type ${instance_type} \
--image cosmos-serving-0.1.1 \
--cluster ${cluster_name} \
--model-spec name=torch-mnist -ms version=1 -cs-github github=${github_url} -cs-branch branch=${branch_name}

코드예제kiml deployment create Sample Code (배포타입: Custom Image)

Shell

kiml deployment create ${deployment_name} \
--endpoint ${endpoint_name} \
--serving-framework custom \
--num-replica 1 \
--instance-type ${instance_type} \
--image ${custom_image} \
--cluster ${cluster_name} \
--protocol gRPC \
--readiness -type=httpGet -path=/healthz -periodSeconds=3 failureThreshold=3 \
--liveness -type=tcpSocket -path=/healthz -periodSeconds=20 failureThreshold=10

kiml deployment delete

배포를 삭제합니다. km dp del 명령어를 사용할 수 있습니다.

코드예제kiml deployment delete Syntax

Shell

kiml deployment delete NAME_OR_ID [--endpoint]
																						[--yes]
																						[--workspace]

표kiml deployment delete Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	삭제할 배포의 이름 또는 ID
--endpoint -ep	TEXT	`선택`	엔드포인트 이름
--yes		`선택`	확인 없이 삭제
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml deployment delete Sample Code

Shell

kiml deployment delete my-mnist-deployment

kiml deployment describe

엔드포인트 내 배포 정보를 조회합니다. km dp desc 명령어를 사용할 수 있습니다.

코드예제kiml deployment describe Syntax

Shell

kiml deployment describe NAME_OR_ID [--endpoint]
																							 [--workspace]
                                               										 [--version]

표kiml deployment describe Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	정보를 조회할 엔드포인트의 이름 또는 ID
--endpoint -ep	TEXT	`선택`	엔드포인트 이름
--version -v	Integer	`선택`	모델 버전 입력
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml deployment describe Sample Code

Shell

kiml deployment describe mnist-deployment -v 1

코드예제kiml deployment describe 결과 화면

Shell

* ID                         | 41329d3616-64ac-4dfe-bfce-08284e05de4d
* Name                       | triton-deployment
* Endpoint Name              | mnist-endpoint
* Serving Framework          | triton
* Resource Flavor            | A1-2-STD
* Replicas                   | 1
* Image                      | cosmos-tritonserver-22.06-py3
* CPU                        | 2
* Memory                     | 8GB
* GPU                        | 
* GPU Memory                 | 
* Port                       | 8080
* Description                | 
* Envs                       | 
* Tags                       | 
* Created At                 | 2022-12-16T02:35:30Z
* Network Options        
  ├──isCanary                   | false
  ├──isMirror                   | false
  ├──mirroring                  | false
  └──weight                     | 100
* Tensorflow Serving     
  ├──maxBatchSize               | 128
  ├──batchTimeOut               | 10000
  ├──maxEnqueuedBatches         | 10
  └──numBatchThreads            | 1
* Triton Inference Server
  └──config                     | platform: "pytorch_libtorch"
                                |  input [
                                |    {
                                |      name: "input__0"
                                |      data_type: TYPE_FP32
                                |      dims: [ 1, 784 ]
                                |    }
                                |  ]
                                |  output [
                                |    {
                                |      name: "output__0"
                                |      data_type: TYPE_FP32
                                |      dims: [ 1, 10 ]
                                |    }
                                |  ]
* Status                     | Available
* PodStatus              
  ├──availableReplicas          | 1
  ├──totalReplicas              | 1
  deployment-41093616-64ac-4dfe-bfce-08284e05de4d-77b574dff-7mxxm
  └──status                     | Running

kiml deployment list

배포 리스트를 조회합니다. km dp ls 명령어를 사용할 수 있습니다.

코드예제kiml deployment list Syntax

Shell

kiml deployment list [--endpoint]
										            [--workspace]

표kiml deployment list Parameters

파라미터	타입	필수 여부	설명
--endpoint -ep	TEXT	`선택`	배포를 조회할 엔드포인트의 이름 또는 ID를 입력 받음
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 설정되지 않은 워크스페이스를 지정할 때 사용

kiml deployment logs

배포 로그를 조회합니다. km dp log 명령어를 사용할 수 있습니다.

코드예제kiml deployment logs Syntax

Shell

kiml deployment logs NAME_OR_ID [--endpoint]
																					[--pod]
																					[--limit_bytes]
																					[--tail]
																					[--since]
																					[--interval]
																					[--follow]
																					[--workspace]

표kiml deployment logs Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	배포 이름 또는 ID
--endpoint -ep	TEXT	`선택`	엔드포인트 이름
--pod -p	Integer	`선택`	파드 번호 - 특정 파드 로그를 조회하고 싶은 경우, 로그에서 파드 번호 확인 후 입력
--limit_bytes -lb	Integer	`선택`	입력한 바이트(Byte) 크기만 로그를 불러옴 - `--follow` 옵션과 사용 불가 - 기본값: 없음 - 최대값: 없음
--tail	Integer	`선택`	마지막 로그부터 입력받은 숫자 만큼의 로그를 조회 - 예) 20 → 로그 1,000줄인 경우 마지막부터 20줄만 보여줌
--since	Integer	`선택`	현재 시점 기준 n초 전까지의 로그 조회(단위: 초) - 예) 3600
--interval -i	Integer	`선택`	로그를 불러오는 주기 (단위: 초) - `--follow`와 함께 사용 - 예) --interval 3 --follow
--follow -f		`선택`	로그를 실시간으로 조회 - `--limit_bytes` 옵션과 사용 불가
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml deployment logs Sample Code

Shell

kiml deployment logs mnist-deployment --follow

kiml deployment restart

배포를 재시작합니다. km dp rs 명령어를 사용할 수 있습니다.

코드예제kiml deployment restart Syntax

Shell

kiml deployment restart NAME_OR_ID [--endpoint]
																						  [--pod]
																						  [--workspace]

표kiml deployment restart Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	재시작할 배포의 이름
--endpoint	TEXT	`선택`	재시작할 배포가 속한 엔드포인트의 이름
--pod -p	TEXT	`선택`	재시작할 파드의 이름
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID, 설정되지 않은 워크스페이스를 지정할 때 사용

코드예제kiml deployment restart Sample Code

Shell

kiml deployment restart mnist-deployment

kiml deployment update

배포를 수정합니다.

코드예제kiml deployment update Syntax

Shell

kiml deployment update NAME_OR_ID [--endpoint]
																						[--serving-framework]
																						[--num-replica]
																						[--instance-type]
																						[--image]
																						[--cluster]
																						[--port]
																						[--mirror]
																						[--traffic-weight]
																						[--model-spec]
																						[--tfserving]
																						[--triton]
																						[--cmserving-github]
																						[--cmserving-code]
																						[--envs]
																						[--description]
																						[--tags]
																						[--workspace]

표kiml deployment update Parameters

파라미터	타입	필수 여부	설명
NAME_OR_ID	TEXT	`필수`	수정할 배포의 이름
--endpoint -ep	TEXT	`필수`	수정할 배포가 속한 엔드포인트의 이름
--serving-framework -sf	TEXT	`선택`	배포를 구성하는 프레임워크를 지정 - 입력 가능한 프레임워크 종류 `tfserving`: TensorFlow Serving `triton`: Triton `cmserving`: Cosmos Serving `custom`: Custom Image
--num-replica -nr	Integer	`선택`	인스턴스 개수
--instance-type -it	TEXT	`선택`	인스턴스 타입
--image -img	TEXT	`선택`	이미지
--port	Integer	`선택`	포트 번호 - 배포 타입이 `custom`인 경우, 미입력 시 `8000`으로 처리 - 그 외 배포 타입은 자동 처리하므로 해당 없음
--mirror	Boolean	`선택`	미러링 모드 -미러를 할 배포에 입력 - `true`: 미러링 모드 사용 - `false`: 미러링 모드 미사용
--traffic-weight	Integer	`선택`	엔드포인트에 인입되는 트래픽을 배포로 분산시키는 가중치 - Canary 배포를 위해 배포가 2개인 경우, 트래픽 비율 입력 - 배포별 트래픽 비율 설정을 위한 0~100 사이의 숫자 입력 - 예) 50
	TEXT	`선택`	배포할 모델 정보
-ms name	TEXT	`선택`	배포할 모델 이름
-ms version	Integer	`선택`	배포할 모델 버전
-ms mountPath	TEXT	`선택`	배포할 모델 경로 (Upload로 생성한 모델일 경우)
	TEXT	`선택`	`tfserving`을 위한 옵션 플래그
-tf allowedBatchSizes=	TEXT	`선택`	배치 작업이 동시에 처리될 배열 - 대기열 및 쉼표(`,`)로 입력 - allowedBatchSizes의 입력값 중 최댓값은 maxBatchSize와 일치해야 함 - 예) “1, 16, 32, 64, 128”
-tf maxBatchSize=128	Integer	`선택`	배치 최대 크기
-tf batchTimeOut=10000	Integer	`선택`	배치 타임아웃 (단위: 초) - 입력한 시간을 초과한 경우, 배치가 자동으로 종료됨
-tf maxEnqueuedBatches=10	Integer	`선택`	대기열에 추가할 최대 배치 크기
-tf numBatchThreads=1	Integer	`선택`	동시에 처리할 수 있는 배치 단위
	TEXT	`선택`	`triton`을 위한 옵션 플래그
-tr config=config.pbtxt	TEXT	`선택`	JSON에 명시된 모델 구성 정보 - 사전에 config.pbtxt 파일 생성 필요
	TEXT	`선택`	배포 타입을 `cmserving`으로 선택한 경우, GitHub으로 불러오기
-cs github={github url}	TEXT	`선택`	사용자 스크립트를 불러올 GitHub 주소 - GitHub Enterprise는 별도 작업 필요 예) `https://github.com/kiml/example.git`
-cs branch={branch name}	TEXT	`선택`	사용자 스크립트를 불러올 GitHub 브랜치 - 입력하지 않을 경우, 설정된 default 브랜치 불러옴
	TEXT	`선택`	배포 타입을 `cmserving`으로 선택한 경우, 스크립트 직접 불러오기
-cs entrypoint=		`선택`	Python을 최초로 실행할 Entrypoint
-cs requirements=		`선택`	Python 설치 패키지 Requirements
--envs	TEXT	`선택`	배포 환경변수 설정 예) `--envs k1=v1`, `--envs k2=v2`
--description -d	TEXT	`선택`	배포 설명
--tags -t	TEXT	`선택`	배포 태그 - Key가 존재하는 경우: Value를 덮어씀 - Key가 존재하지 않는 경우: 새로운 Key를 추가함 예) `-t k1=v1`, `-t k2=v2`
--workspace -w	TEXT	`선택`	워크스페이스 이름 또는 ID로, 설정되지 않은 워크스페이스를 지정할 때 사용함

코드예제kiml deployment update Sample Code

Shell

kiml deployment update mnist-deployment \
--endpoint mnist-endpoint \
--serving-framework triton \
--instance-type ${instance_type} \
--num-replica 1 \
--image cosmos-tritonserver-22.06-py3 \
--cluster ${cluster_name}
--port 8080 \
--model-spec name=mnist-model \
--triton config=config.pbtxt

Kakao i Machine Learning::CLI 명령어 참조

페이지 이동경로

CLI Command Reference

전역으로 사용 가능한 매개 변수

kiml version

kiml version

kiml context

kiml context add

kiml context init

kiml context list

kiml context set

kiml login / logout

kiml login

kiml logout

kiml applicationcredential

kiml applicationcredential create

kiml applicationcredential set

kiml applicationcredential delete

kiml applicationcredential describe

kiml applicationcredential list

kiml instance-type

kiml instance-type

kiml workspace

kiml workspace create

kiml workspace delete

kiml workspace add-member

kiml workspace delete-member

kiml workspace describe

kiml workspace list

kiml workspace list-member

kiml workspace set

kiml workspace show

kiml workspace update

kiml workspace user-roles

kiml storage

kiml storage describe

kiml storage list

kiml storage update

kiml data

kiml data data-usage

kiml data list

kiml data download

kiml data remove

kiml data upload

kiml dataset

kiml dataset create

kiml dataset delete

kiml dataset describe

kiml dataset list

kiml dataset update

kiml compute-instance

kiml compute-instance create

kiml compute-instance delete

kiml compute-instance describe

kiml compute-instance exec

kiml compute-instance lab

kiml compute-instance list

kiml compute-instance start

kiml compute-instance stop

kiml compute-instance update

kiml image

kiml image create

kiml image delete

kiml image describe

kiml image list

kiml image logs

kiml image update

kiml experiment

kiml experiment create

kiml experiment delete

kiml experiment describe

kiml experiment list

kiml experiment tensorboard

kiml experiment update

kiml run

kiml run submit

kiml run delete

kiml run describe

kiml run exec

kiml run list