Inference

`detection.InferenceHandler`

학습한 Object Detection 모델을 사용하여 검사를 하기 위한 InferenceHandler class 입니다.

Usage

# 인퍼런스 모듈 빌드
inferene_build_config = {
    "checkpoint_path": CHECKPOINT_PATH,
    "password": PASSWORD,
    "device": DEVICE,
}
error, inference_handler = InferenceHandler.build(inferene_build_config)
assert error >= 0

# 모듈 정보 확인
error, metadata = read_metadata(CHECKPOINT_PATH)
assert error >= 0
print("Inference metadata:", metadata)

# 인퍼런스 옵션 초기값 확인
n_classes = CONFIG["n_classes"]
inference_options = {
    "outputs.filtered_bboxes": True,
    "outputs.time": False,
    "params.score_threshold": [0] * n_classes,
    "params.area_threshold": [0] * n_classes,
    "params.max_num_boxes": [1] * n_classes,
    "params.batch_size": 1,
}
print("Default inference options:")
for key in inference_options:
    error, value = inference_handler.get_default_inference_option(key)
    assert error >= 0
    print(f"  {key}: {value}")

# 디벨로퍼: Analyze 수행
error, _ = inference_handler.set_analysis_data(images=DATA["validation_images"], labeled=True)
assert error >= 0

error, analysis_steps = inference_handler.initialize_analysis()
assert error >= 0

for _ in range(analysis_steps):
    error, _ = inference_handler.step_analysis()
    assert error >= 0

error, analysis_results = inference_handler.finalize_analysis()
assert error >= 0
print("Analysis results:", analysis_results)

# 디벨로퍼: 인퍼런스 옵션 변경
for key, value in inference_options.items():
    error, _ = inference_handler.set_inference_option(key, value)
    assert error >= 0

# 디벨로퍼: metadata에 inference_option 저장 (예시)
metadata["inference_options"] = inference_options
error, _ = write_metadata(CHECKPOINT_PATH, metadata)
assert error >= 0

# 인퍼런스 옵션이 잘 변경되었는지 확인
print("Inference options:")
for key in inference_options:
    error, value = inference_handler.get_inference_option(key)
    assert error >= 0
    print(f"  {key}: {value}")

# 디벨로퍼: 새로운 세팅으로 Analyze 재수행
error, analysis_results = inference_handler.analyze_with_existing_data()
assert error >= 0
print("Analysis results:", analysis_results)

# 런타임: 핸들러 빌드
error, metadata = read_metadata(CHECKPOINT_PATH)
assert error >= 0
inferene_build_config["inference_options"] = metadata["inference_options"]
error, inference_handler = InferenceHandler.build(inferene_build_config)
assert error >= 0

# 런타임 검사: 후처리까지 한번에 최적화된 연산으로 수행
image_id = next(iter(DATA["validation_images"]))
image_path = DATA["validation_images"][image_id]["path"]
error, output = inference_handler.infer_and_postprocess(images=[image_path])
assert error >= 0
print("Runtime (infer_and_postprocess):", output)

`build(config)` `classmethod`

InferenceHandler class의 instance를 생성합니다.

Parameters:

Name Type Description Default

config

Dict

InferenceHandler를 build 하기 위한 config가 담겨 있는 dictionary 입니다.

{
    "checkpoint_path": str,  # 체크포인트 경로
    "inference_options": Optional[Dict], # 인퍼런스 옵션 config (default None). 구조는 `get_default_inference_option`의 Keys 참고.
    "password": Optional[str],  # 체크포인트 패스워드 (default None)
    "device": Union[int, str],  # GPU 번호 (int) or "cpu" (str) (default "cpu")
}

required

Returns:

Name	Type	Description
`InferenceHandler`	`InferenceHandler`	build가 완료된 detection.InferenceHandler class의 instance를 반환합니다.

`get_default_inference_option(key)`

Inference & postprocess 옵션의 기본 설정 값을 반환합니다.

Parameters:

Name	Type	Description	Default
`key`	`str`	옵션 key	required

Returns:

Name	Type	Description
`Any`	`Any`	옵션 value

Keys

사용 가능한 key와 value 목록:

{
    "outputs.filtered_bboxes": bool,  # (default True, 예측된 박스들을 스코어, 면적, 개수로 필터링을 할 지 여부. True인 경우 필터링)
    "outputs.time": bool,  # (default False, 인퍼런스 시 각 요소에 걸린 시간 측정 여부. True인 경우 측정)
    "params.score_threshold": List[int],  # 각 클래스의 score threshold 값. 예측 box의 score가 threshold보다 작은 경우 필터링 됩니다.
                                          # 각 값은 [0, 100] 범위의 정수. (default [0, ... , 0])
    "params.area_threshold": List[int],  # 각 클래스의 area threshold 값. 예측 box의 면적이 threshold보다 작은 경우 필터링 됩니다.
                                         # 각 값은 0 이상의 정수. (default [0, ... , 0])
    "params.max_num_boxes": List[int],  # 각 클래스의 최대 예측 박스 개수. 예측 box의 개수가 이 값을 넘을 경우 score가 낮은 순으로 제거됩니다.
                                        # 각 값은 -1 이상의 정수이며, 값이 -1인 경우 개수 필터링을 적용하지 않습니다. (default [-1, ... , -1])
    "params.batch_size": int,  # `infer_and_postprocess`에 한 번에 입력할 수 있는 최대 이미지 개수 입니다.
                                   # 파라미터가 변경되는 경우 해당 값으로 warmup을 수행합니다.
                                   # (default 1)
}

사용 예시:

error, _ = handler.get_default_inference_option(key="outputs.filtered_bboxes")
error, _ = handler.set_inference_option(key="outputs.filtered_bboxes", value=False)

`get_inference_option(key)`

현재 설정된 inference & postprocess 옵션 값을 읽습니다.

Parameters:

Name	Type	Description	Default
`key`	`str`	옵션 key	required

Returns:

Name	Type	Description
`Any`	`Any`	옵션 value

Keys

get_default_inference_option과 동일합니다.

`set_inference_option(key, value)`

Inference & postprocess 옵션을 설정합니다.

Parameters:

Name	Type	Description	Default
`key`	`str`	설정하고자 하는 옵션 key 입니다.	required
`value`	`Any`	설정하고자 하는 옵션 value 입니다.	required

Returns:

Name	Type	Description
`None`	`None`	None

Keys

get_default_inference_option과 동일합니다.

`infer_and_postprocess(images)`

image의 List를 입력으로 받아 모델 인퍼런스와 후처리를 수행합니다. (for Runtime) 실시간 검사를 위해 연산 과정이 최적화되어 있으며, 중간 결과를 제거하고 postprocess 최종 결과만을 반환합니다.

Parameters:

Name Type Description Default

images

Union[List[np.ndarray], List[str]]

- List[np.ndarray]: numpy image가 들어있는 List 입니다. 각 image는 다음 제약 조건을 갖습니다.
                    data type: uint8, uint16
                    channel: H x W / H x W x 1 - Gray
                             H x W x 3 - RGB
                             H x W x 4 - RGBA
- List[str]: image 경로가 들어있는 List 입니다.
- List[List[np.ndarray]]: multipage인 경우 사용.
- List[List[str]]: multipage인 경우 사용.

required

Returns:

Type Description

List[Dict]

List[Dict]: image의 postprocess 결과들이 들어있는 List 입니다.

[
    {  # 아래 키들 중 inference_options에 설정된 출력 값(outputs)들만 포함.
        "filtered_bboxes: [  # List[Dict], 설정된 score_threshold, area_threshold, max_num_boxes에 의해 필터된 예측 bbox 리스트
            {
                "bounding_box": List[int],  # 예측된 bounding box의 coordinate, [left, top, width, height]
                "class_index": int,  # 예측된 bounding box의 class index
                "score": int,  # 예측된 bounding box의 score
            }
        ]
        "time": {  # inference에 소요된 시간을 담고있는 dictionary 입니다. (단위: ms)
            "imread_time": float,  # 실제 image를 load하여 연구팀이 사용하는 image format (PIL)으로 변경하기까지 걸리는 시간 (각 이미지 별로 걸리는 시간)
            "inference_time": float,  # resize, roi, tensorize, network forward 등을 포함하는 시간 (각 이미지 별로 걸리는 시간)
            "post_processing_time": float,  # postprocess에 걸린 시간 (각 이미지 별로 걸리는 시간)
        },
    },
    ...,  # times number of images
]

`set_analysis_data(images, labeled)`

Analysis를 위한 data를 세팅합니다. (for Developer)

Parameters:

Name Type Description Default

images

Dict[str, Dict]

analysis에 사용할 데이터 리스트. Trainer 빌드에 사용하는 이미지 리스트와 동일한 구조.

{
    "{image_id}": {
        "path": Union[str, List[str]],  # 이미지 경로 (multipage인 경우 경로 리스트)
        "width": int,  # image width
        "height": int,  # image height
        "labels": [  # (labeled = False)인 경우 필요하지 않습니다.
            {
                "class_index": int,
                "bounding_box": List[int],  # [left, top, width, height]
            },
            ...,  # times number of labels in the image
        ],
    },
    ...,  # times number of images
}

required

labeled

bool

label 존재 여부. label 존재 여부에 따라 analysis 결과 Dict 구성 요소가 달라집니다.

required

Returns:

Name	Type	Description
`None`	`None`	None

Note1

Analysis를 위한 api는 정해진 순서대로 호출되어야 하며, 순서를 벗어나는 경우 에러를 raise합니다.

API호출 예시:

error, _ = handler.set_analysis_data(images, labeled)  # 데이터 지정
error, total_steps = handler.initialize_analysis()  # 초기화
for _ in range(total_steps):
    error, _ = handler.step_analysis()  # 정해진 수 만큼 스텝 수행
error, results = handler.finalize_analysis()  # 마무리 & 결과 리턴

# 인퍼런스 옵션 변경
for key, value in inference_options.items():
    error, _ = handler.set_inference_option(key, value)
error, total_steps = handler.initialize_analysis()  # 초기화
for _ in range(total_steps):
    error, _ = handler.step_analysis()  # 정해진 수 만큼 스텝 수행
error, results = handler.finalize_analysis()  # 마무리 & 결과 리턴

# 인퍼런스 옵션 변경
for key, value in inference_options.items():
    error, _ = handler.set_inference_option(key, value)
error, results = handler.analyze_with_existing_data()  # 초기화 - 스텝 - 마무리를 한 번에 수행 후 결과 리턴

Note2

inference_options 세팅에 따라 analysis 결과 Dict 구성 요소가 달라집니다.

ex) inference_options outputs 중 filtered_bboxes: False 인 경우 f1 관련 metric 값들이 제공되지 않습니다.

따라서 Analysis 도중 (initialize_analysis와 finalize_analysis 사이)에는 set_inference_option를 호출할 수 없습니다.

`initialize_analysis()`

Analysis를 위한 준비 스텝을 수행.

Returns:

Name	Type	Description
`int`	`int`	Analysis 완료를 위해 수행되어야 하는 `step_analysis` 호출 횟수.

`step_analysis()`

Analysis를 1스텝 수행.

Returns:

Name	Type	Description
`None`	`None`	None

`finalize_analysis()`

Analysis를 마무리하고 결과를 리턴.

Returns:

Name	Type	Description
`Dict`	`Dict`	Analysis 결과 name="__codelineno-0-1" href="#__codelineno-0-1">{ "images": { "{image_id}": { "labels": [ # "labels" 결과는 labeled=True인 경우에만 존재 { "correct": bool, # True면 TP, False면 FN "iou": float, # label box에 대해 예측된 bounding box와 계산된 iou 값 }, ... # 입력으로 넣어준 labels와 동일한 개수 ], "predictions": { # 아래 키들 중 inference_options에 설정된 출력 값들만 포함. "filtered_bboxes: [ # List[Dict] { "bounding_box": List[int], # 예측된 bounding box의 coordinate, [left, top, width, height] "class_index": int, # 예측된 bounding box의 class index "score": int, # 예측된 bounding box의 score "iou": float, # 예측 box에 대해 label box와 계산된 iou 값 "correct": bool, # True면 TP, False면 FP } ], "object/underkill": int, # 현재 이미지의 label box 중 underkill 개수 "object/overkill": int, # 현재 이미지의 pred box 중 overkill 개수 "time": { # inference에 소요된 시간을 담고있는 dictionary 입니다. (단위: ms) "imread_time": float, # 실제 image를 load하여 연구팀이 사용하는 image format (PIL)으로 변경하기까지 걸리는 시간 (각 이미지 별로 걸리는 시간) "inference_time": float, # resize, roi, tensorize, network forward 등을 포함하는 시간 (각 이미지 별로 걸리는 시간) "post_processing_time": float, # postprocess에 걸린 시간 (각 이미지 별로 걸리는 시간) }, }, }, ... # 입력으로 넣어준 이미지 개수만큼 반복 }, "summary": { # accuracy "object/accuracy": float, # object-wise accuracy # underkill "object/underkill": int, # 라벨 object 중 검출하지 못한 라벨의 개수 (미검) "object/class_{idx}_underkill": int, # 클래스가 idx인 라벨 object 중 검출하지 못한 라벨의 개수 # overkill "object/overkill": int, # 예측 object 중 틀린 예측의 개수 (과검) "object/class_{idx}_overkill": int, # 클래스가 idx인 예측 object 중 틀린 예측의 개수 # f1 "object/mean_f1": float, # object-wise mean f1-score "object/class_{idx}_f1": float, # 클래스가 idx인 box에 대한 object-wise mean f1-score # confusion matrix "object/confusion_matrix": List[List[int]], # object-wise confusion matrix, 마지막 dimension은 wrong을 의미하는 etra dimension (n_class + 1) [ # n_class == 3이라고 할 때 [1, 0, 0, 1], # 라벨이 class0인 object 중 미검 1개, 맞춘것 1개 [0, 2, 0, 4], # 라벨이 class2인 object 중에 미검 4개, 맞춘 것 2개 [0, 0, 3, 0], # 라벨이 class2인 object 중에 미검 2개, 맞춘 것 3개 [5, 0, 3, 0], # class0이라고 예측한 과검 5개, class2라고 예측한 과검 3개 ] }, class="p">}

`analyze_with_existing_data()`

기존에 세팅된 데이터를 이용해 전체 analysis를 루틴을 수행하고 최종 결과를 리턴.

Note

해당 함수는 아래 루틴을 호출하는 것과 동일함:

error, total_steps = handler.initialize_analysis()  # 초기화
for _ in range(total_steps):
    error, _ = handler.step_analysis()  # 정해진 수 만큼 스텝 수행
error, results = handler.finalize_analysis()  # 마무리 & 결과 리턴

Returns:

Name	Type	Description
`Dict`	`Dict`	Analysis 결과 (`InferenceHandler.finalize_analysis` 리턴 값과 동일)

`warmup()`

현재 설정된 inference 옵션을 바탕으로 warmup을 수행합니다. warmup은, 현재 inference_option이 잘 동작하는지 확인 + GPU를 첫 호출시 속도가 느린 이슈를 해결하기 위해, 현재 inference_option에 맞춰 더미 입력에 대한 InferenceHandler.infer_and_postprocess를 호출합니다.

Inference

detection.InferenceHandler

build(config) classmethod

get_default_inference_option(key)

get_inference_option(key)

set_inference_option(key, value)

infer_and_postprocess(images)

set_analysis_data(images, labeled)

initialize_analysis()

step_analysis()

finalize_analysis()

analyze_with_existing_data()

warmup()

`detection.InferenceHandler`

`build(config)` `classmethod`

`get_default_inference_option(key)`

`get_inference_option(key)`

`set_inference_option(key, value)`

`infer_and_postprocess(images)`

`set_analysis_data(images, labeled)`

`initialize_analysis()`

`step_analysis()`

`finalize_analysis()`

`analyze_with_existing_data()`

`warmup()`