> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ko/self-hosted/sdks/web-browser/inferencejs-reference.md).

# inferencejs 참조

Roboflow로 구축된 컴퓨터 비전 애플리케이션을 웹/JavaScript 환경에 배포하기 위한 엣지 라이브러리인 \`inferencejs\`에 대한 참조입니다.

{% hint style="info" %}
자세히 알아보기 `inferencejs` , 웹 SDK에 대한 자세한 내용은 [여기](https://docs.roboflow.com/deployment/ko/self-hosted/sdks/web-browser.md)
{% endhint %}

### 설치

이 라이브러리는 vite, webpack, parcel 등의 번들러를 사용해 브라우저에서 실행하도록 설계되었습니다. 번들러가 설정되어 있다면 다음 명령을 실행해 설치할 수 있습니다.

`npm install inferencejs`

### 시작하기

먼저 `InferenceEngine`.을 초기화합니다. 그러면 사용자 인터페이스를 차단하지 않고 모델을 다운로드하고 실행할 수 있는 백그라운드 작업자가 시작됩니다.

```typescript
import { InferenceEngine } from "inferencejs";

const PUBLISHABLE_KEY = "rf_a6cd..."; // replace with your own publishable key from Roboflow

const inferEngine = new InferenceEngine();

// Load a model by its model id, copied from the model's page on Roboflow.
const workerId = await inferEngine.startWorkerByModelId("[MODEL ID]", PUBLISHABLE_KEY);

//make inferences against the model
const result = await inferEngine.infer(workerId, img);
```

모델 ID는 모델 페이지에 표시되며 다음과 같은 형식입니다. `workspace/model-slug` (예: `my-workspace/hard-hat-abc-1-yolov8n-t1`). 레거시 프로젝트 버전 모델은 프로젝트 슬러그와 버전 번호를 사용해 `startWorker` 로 로드할 수 있습니다. 학습된 모델이 여러 개 있는 버전의 경우 레거시 `{project}/{version}` ID는 버전에 별칭이 있으면 해당 별칭을 통해 확인됩니다. 별칭이 없으면 해당 버전에 모델이 하나뿐인 경우에만 사용할 수 있습니다. 모델이 여러 개라 ID가 모호한 경우 모델 자체의 ID로 모델을 로드해야 합니다. 자세한 내용은 [레거시 ID 확인 방법](https://docs.roboflow.com/models/model-ids).

## API

### InferenceEngine

**`new InferenceEngine()`**

새 InferenceEngine 인스턴스를 생성합니다.

**`startWorkerByModelId(modelId: string, publishableKey: string): Promise<number>`**

지정된 모델 ID의 새 작업자를 시작하고 `workerId`를 반환합니다. 모델을 로드할 때 권장되는 방법입니다. `modelId` 는 모델 페이지에 표시되는 전체 `workspace/model-slug` ID이며, 버전이 지정되지 않은 버전과 모델이 여러 개인 버전에서 사용할 수 있습니다. `publishableKey` 는 필수이며 Roboflow의 프로젝트 설정에서 확인할 수 있습니다.

**`startWorker(modelName: string, modelVersion: number, publishableKey: string): Promise<number>`**

프로젝트 URL 슬러그와 정수 버전으로 지정한 레거시 모델을 로드하고 `workerId`를 반환합니다. 새로 통합하는 경우 `startWorkerByModelId` 를 사용하세요. `publishableKey` 는 필수이며 Roboflow의 프로젝트 설정에서 확인할 수 있습니다.

**`infer(workerId: number, img: CVImage | ImageBitmap): Promise<Inference>`**

지정된 `workerId`. `img 이미지로 워커에서 추론합니다.` 다음 방법으로 생성할 수 있습니다. `new CVImage(HTMLImageElement | HTMLVideoElement | ImageBitmap | TFJS.Tensor)` 또는 [`createImageBitmap`](https://developer.mozilla.org/en-US/docs/Web/API/createImageBitmap)

**`stopWorker(workerId: number): Promise<void>`**

지정된 워커를 중지합니다. `workerId`.

### `YOLO Lite` `YOLOv8` `YOLOv5`

다음을 사용해 추론한 결과는 `InferenceEngine` YOLO Lite, YOLOv8 또는 YOLOv5 객체 감지 모델에 대한 결과이며, 다음 유형의 배열입니다:

```typescript
type RFObjectDetectionPrediction = {
    class?: string;
    confidence?: number;
    bbox?: {
        x: number;
        y: number;
        width: number;
        height: number;
    };
    color?: string;
};
```

### `GazeDetections`

다음을 사용하여 추론을 수행한 결과입니다. `InferenceEngine` Gaze 모델에 대해 추론한 결과입니다. 다음 타입의 배열입니다:

```typescript
type GazeDetections = {
    leftEye: { x: number; y: number };
    rightEye: { x: number; y: number };
    yaw: number;
    pitch: number;
}[];
```

**`leftEye.x`**

입력 이미지 너비에 대한 백분율로 측정한 왼쪽 눈의 x 위치입니다. 값은 0과 1 사이의 부동 소수점 숫자입니다.

**`leftEye.y`**

입력 이미지 높이에 대한 백분율로 측정한 왼쪽 눈의 y 위치입니다. 값은 0과 1 사이의 부동 소수점 숫자입니다.

**`rightEye.x`**

입력 이미지 너비에 대한 백분율로 측정한 오른쪽 눈의 x 위치입니다. 값은 0과 1 사이의 부동 소수점 숫자입니다.

**`rightEye.y`**

입력 이미지 높이에 대한 백분율로 측정한, 0과 1 사이의 부동 소수점 숫자로 나타낸 오른쪽 눈의 y 위치입니다.

**`yaw`**

시각적 시선의 요(yaw) 각도로, 라디안 단위로 측정합니다.

**`pitch`**

시각적 시선의 피치(pitch) 각도로, 라디안 단위로 측정합니다.

### `CVImage`

컴퓨터 비전 작업에 사용할 수 있는 이미지를 나타내는 클래스입니다. 이미지를 조작하고 변환하는 다양한 메서드를 제공합니다.

#### **생성자**

해당 `CVImage(image)` 클래스 생성자는 클래스의 새 인스턴스를 초기화합니다. 다음 유형 중 하나의 이미지를 인수로 받습니다.

* `ImageBitmap`(선택적) 이미지의 `ImageBitmap` 표현입니다.
* `HTMLImageElement`(선택적) 이미지의 `HTMLImageElement` 표현입니다.
* `tf.Tensor`(선택적) 이미지의 `tf.Tensor` 표현입니다.
* `tf.Tensor4D`선택적 4D `tf.Tensor` 이미지 표현입니다.

#### **메서드**

**`bitmap()`**

이미지의 `ImageBitmap` 표현으로 확인되는 프라미스를 반환합니다. 이미지가 이미 비트맵이면 캐시된 비트맵을 반환합니다.

**`tensor()`**

이미지의 `tf.Tensor` 표현을 반환합니다. 이미지가 이미 텐서이면 캐시된 텐서를 반환합니다.

**`tensor4D()`**

이미지의 4D `tf.Tensor` 표현으로 확인되는 프라미스를 반환합니다. 이미지가 이미 4D 텐서이면 캐시된 4D 텐서를 반환합니다.

**`array()`**

이미지를 JavaScript 배열로 표현한 값으로 확인되는 프라미스를 반환합니다. 이미지가 이미 텐서이면 해당 텐서를 배열로 변환합니다.

**`dims()`**

이미지의 차원이 포함된 배열을 반환합니다. 이미지가 비트맵이면 `[width, height]`를 반환합니다. 이미지가 텐서이면 텐서의 형태를 반환합니다. 이미지가 HTML 이미지 요소이면 `[width, height]`.

**`dispose()`**

메모리를 확보하기 위해 이미지의 텐서 표현을 해제합니다.

**`static fromArray(array: tf.TensorLike)`**

주어진 텐서 유사 배열로부터 새 `CVImage` 인스턴스를 생성합니다.
