콘텐츠로 이동

API 레퍼런스

lccl은 같은 라이브러리를 두 가지 표면으로 제공합니다. C++ 표면이 정의이고 Python 표면은 그것을 바인딩합니다.

표면 진입 방법 레퍼런스
C++ #include "lccl.h" C++ API — 공개 헤더의 주석 기준
Python import lccl Python API

이 API는 C 스타일이지만 공개 헤더는 C++ 전용(디폴트 인자, nullptr)이고 함께 include하는 hart 헤더가 C++17 기능을 쓰므로, C++17 이상으로 컴파일해야 합니다.

랭크 간 호출 순서, 그룹이 보장하는 것, 실패가 남기는 상태 같은 의미는 두 표면이 동일하며 프로그래밍 가이드에서 한 번만 설명합니다. 이 절은 시그니처를 다룹니다.


이름 대응

Python 함수 이름은 C++ 이름에서 Lccl 접두사를 떼고 snake_case로 바꾼 것입니다. 타입 이름은 Lccl 접두사를 그대로 두고, 열거 값은 k만 뗍니다(kLcclFloat16이 LcclDataType.LcclFloat16).

C++ Python
LcclGetUniqueId() get_unique_id()
LcclCommInitRank() comm_init_rank()
LcclCommInitAll() comm_init_all()
LcclCommDestroy() comm_destroy()
LcclGroupStart() / LcclGroupEnd() group_start() / group_end()
LcclAllReduce() all_reduce()
LcclReduceScatter() reduce_scatter()
LcclSend() / LcclRecv() send() / recv()

Python에 없는 진입점과 그 밖의 예외는 C++ API와의 차이에 정리되어 있습니다.


공개 헤더

공개 헤더는 lccl.h 하나입니다. 커뮤니케이터, 집합 연산, 점대점, 그룹, 타입과 헬퍼가 모두 여기에 선언되어 있고, 다른 LCCL 헤더는 include하지 않습니다. collectives.h, group.h를 비롯한 소스 트리의 다른 헤더는 내부용입니다.

lccl.h는 lccl을 설치한 site-packages의 lccl/include/에 들어 있습니다. lccl.h가 hart의 공개 헤더(ha_types.h)를 include하므로 hart 패키지의 include/도 include 경로에 있어야 합니다. 빌드와 링크 방법은 C++ API를 보십시오.


영역별 진입점

영역 진입점
커뮤니케이터 LcclGetUniqueId, LcclCommInitRank, LcclCommInitAll, LcclCommInitRankConfig, LcclCommFinalize, LcclCommDestroy, LcclCommAbort, LcclCommCount, LcclCommUserRank, LcclCommHaDevice, LcclCommGetAsyncError
버퍼 등록 LcclCommRegister, LcclCommDeregister
집합 연산 LcclAllReduce, LcclReduce, LcclReduceScatter, LcclBroadcast, LcclAllGather, LcclGather, LcclScatter, LcclAllToAll
점대점 LcclSend, LcclRecv
그룹 LcclGroupStart, LcclGroupEnd
타입과 헬퍼 LcclTypeSize, LcclDataTypeToString, LcclRedOpToString, LcclGetErrorToString

공통 의미

API 전반에 적용되는 속성입니다. 진입점별 상세는 각 레퍼런스에 있습니다.

속성 값
반환 타입 타입·문자열 헬퍼(LcclTypeSize, *ToString)를 제외한 모든 C++ 진입점이 LcclResult 반환. 출력은 포인터 파라미터로 전달
예외 던지지 않음. Python은 RuntimeError를 발생
버퍼 hart에서 얻은 디바이스 포인터. lccl이 할당하지 않음
count 바이트가 아니라 원소 수. 0은 kLcclInvalidArgument
순서 모든 랭크가 같은 집합 연산을 같은 순서로 호출해야 함
미지원 조합 호출한 지점(그룹 안이면 LcclGroupEnd())에서 kLcclNotSupported로 거부. 아무것도 전송되지 않음. LPU의 제약은 지원 매트릭스 확인
완료 시점 블로킹 커뮤니케이터에서는 반환될 때 이미 완료. 호출 전에 큐잉한 스트림 작업을 기다린다는 보장은 없음
스트림 대부분 HaStream_t를 받으며 기본값은 호출 스레드의(디바이스별) 기본 스트림. LcclAllGather, LcclAllToAll, LcclSend, LcclRecv는 받지 않음
단일 랭크 로컬 복사로 지름길 처리

함께 보기