Inference

`segmentation.InferenceHandler`

학습한 Segmentation 모델을 사용하여 검사를 하기 위한 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.mask": True,
    "outputs.scoremap": True,
    "outputs.objects": True,
    "outputs.time": False,
    "params.object_boundary_threshold": [50] * n_classes,
    "params.calc_object_area_and_apply_threshold": True,
    "params.calc_object_score_and_apply_threshold": True,
    "params.object_area_threshold": [10] * n_classes,
    "params.object_score_threshold": [60.0] * n_classes,
    "params.batch_size": 1,
    "params.inspection_size_wh": [256, 256],
    "params.oversized_image_handling": "resize_to_fit",
}
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_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가 완료된 segmentation.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 목록:



name="__codelineno-0-1" href="#__codelineno-0-1">{ "outputs.mask": bool,  # (default True, output 중 mask를 계산할 지 여부. True인 경우 계산) "outputs.scoremap": bool,  # (default True, output 중 scoremap을 계산할 지 여부. True인 경우 계산) "outputs.objects": bool,  # (default True, output 중 objects를 계산할 지 여부. True인 경우 계산) "outputs.time": bool,  # (default False, 인퍼런스 시 각 요소에 걸린 시간 측정 여부. True인 경우 측정) "params.object_boundary_threshold": List[int],  # mask를 계산할 때 적용되며, 각 클래스별로 픽셀의 스코어값이 threshold보다 작은 경우 스코어가 0으로 치환 됩니다. 각 값은 [0, 255] 범위의 정수. (default [100, ... , 100]) "params.calc_object_area_and_apply_threshold": bool,  # True인 경우 object마다 area(=픽셀수)를 계산하고 object_area_threshold를 적용합니다. # outputs.objects가 True일때만 적용. # (default True) "params.calc_object_score_and_apply_threshold": bool,  # True인 경우 object마다 평균 score를 계산하고 object_score_threshold를 적용합니다. # outputs.objects가 True일때만 적용. # (default True) "params.object_area_threshold": List[int],  # 각 클래스별로 예측된 object의 면적이 threshold보다 작은 경우 필터링 됩니다. 각 값은 0 이상의 정수. (default [0, ... , 0]) "params.object_score_threshold": List[float],  # 각 클래스별로 예측된 object의 평균 score가 threshold 보다 작은 경우 필터링 됩니다. 각 값은 [0.0, 255.0] 범위의 실수. (default [0.0, ... , 0.0]) "params.batch_size": int,  # `infer_and_postprocess`에 한 번에 입력할 수 있는 최대 이미지 개수 입니다. # 파라미터가 변경되는 경우 해당 값으로 warmup을 수행합니다. # (default 1) "params.inspection_size_wh": Optional[List[int]],  # inference를 할 때, 내부 연산이 진행되는 image size 입니다. # input image가 inspection_size_wh 넘는 경우 aspect ratio를 유지하며 resize 됩니다. # input image가 inspection_size_wh 보다 작은 경우 부족한 부분을 zero padding으로 채웁니다. # 파라미터가 변경되는 경우 해당 값으로 warmup을 수행합니다. # (default None) "params.oversized_image_handling": str,  # inference시 inspection_size_wh 보다 큰 이미지에 대한 핸들링 옵션 입니다. # 아래 옵션들 중 한 가지를 선택할 수 있습니다. #   "do_not_inspect" - 큰 이미지가 들어오면 에러 레이즈 #   "resize_to_fit" - 큰 이미지가 들어오면 inspection_size_wh 로 리사이즈해서 검사 #   "crop_into_tiles" - 큰 이미지가 들어오면 inspection_size_wh 크기의 타일로 잘라서 검사 # (default "do_not_inspect") class="p">}
사용 예시:
    
handler.get_default_inference_option(key="outputs.mask")
handler.set_inference_option(key="outputs.mask", 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에서 warmup이 필요한 [params.inspection_size_wh, params.batch_size]를 제외하면 동일합니다.

  








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에 설정된 출력 값들만 포함.
        "mask": ndarray(uint8, shape=(H, W)),  # 각 픽셀이 예측된 클래스를 값으로 갖는 array 입니다.
        "scoremap": ndarray(uint8, shape=(C, H, W)),  # 각 클래스별로 픽셀의 score가 저장된 array
        "objects": [  # 클래스별로 contouring을 해서 얻은 object들의 리스트. (List[Dict])
            {  # segmentation object 구조
                "class_index": int,
                "contours": [  # cv2 형식의 contours. 0번째 contour가 outer, 나머지는 모두 inner.
                    ndarray(int32, shape=(52, 1, 2)),
                    ndarray(int32, shape=(44, 1, 2)),
                    ndarray(int32, shape=(11, 1, 2)),
                    ...,  # times number of contours
                ],
                "area": int,  # object의 픽셀 수. calc_object_score_and_apply_threshold True일때만 존재하는 key입니다.
                "score": float,  # object의 anomaly score. calc_object_score_and_apply_threshold가 True일때만 존재하는 key입니다.
                "bounding_box": List[int],  # [left, top, width, height]
                "bounding_rot_box": List,  # [[center_x, center_y], [width, height], angle, [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]], all items are float
                "fitted_ellipse": List,  # [[center_x, center_y], [width, height], angle], all items are float
            },
            ...,  # times number of objects
        ],
        "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,  # class index (0: background)
                "bounding_box": List[int],  # [left, top, width, height]
                "bitmap": str,  # base64 encoded png image string (shape: (height, width))
            },
            ...,  # 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 중 mask: False 인 경우 pixel 관련 metric 값들이 제공되지 않습니다.
따라서 Analysis 도중 (initialize_analysis와 finalize_analysis 사이)에는 set_inference_options를 호출할 수 없습니다.

  








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 결과
{
    "images": {
        "{image_id}": {
            "labels": [  # "labels" 결과는 labeled=True인 경우에만 존재
                {
                    "correct": bool,  # True면 TP, False면 FN
                    "recall": float,  # recall - 라벨 영역 중 맞은 영역의 비율
                },
                ... # 입력으로 넣어준 labels와 동일한 개수
            ],
            "predictions": {  # 아래 키들 중 inference_options에 설정된 출력 값들만 포함.
                "mask": ndarray(uint8, shape=(H, W)),  # 각 픽셀이 예측된 클래스를 값으로 갖는 array.
                "scoremap": ndarray(uint8, shape=(C, H, W)),  # 각 클래스별로 픽셀의 score가 저장된 array.
                "objects": [  # (List[Dict]) 클래스별로 contouring을 해서 얻은 object들의 리스트.
                    {
                        "class_index": int,
                        "contours": [  # cv2 형식의 contours. 0번째 contour가 outer, 나머지는 모두 inner.
                            ndarray(int32, shape=(52, 1, 2)),
                            ndarray(int32, shape=(44, 1, 2)),
                            ndarray(int32, shape=(11, 1, 2)),
                            ...  # contour 개수 만큼 반복
                        ],
                        "area": int,  # object의 픽셀 수. calc_object_score_and_apply_threshold True일때만 존재하는 key입니다.
                        "score": float,  # object의 anomaly score. calc_object_score_and_apply_threshold가 True일때만 존재하는 key입니다.
                        "bounding_box": List[int],  # [left, top, width, height]
                        "bounding_rot_box": List,  # [[center_x, center_y], [width, height], angle, [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]], all items are float
                        "fitted_ellipse": List,  # [[center_x, center_y], [width, height], angle], all items are float
                        # 아래 항목들은 labeled=True인 경우에만 존재
                        "correct": bool,  # True면 TP, False면 FP.
                        "precision": float,  # precision - 예측 영역 중 맞은 영역의 비율.
                    },
                    ... # 이미지 내의 검출된 object 개수만큼 반복
                ],
                "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에 걸린 시간 (각 이미지 별로 걸리는 시간)
                },
                "object/underkill": int,  # 이미지 내에서 라벨 object 중 검출하지 못한 라벨의 개수 (미검)
                "object/overkill": int,  # 이미지 내에서 예측 object 중 틀린 예측의 개수 (과검)
            },
        },
        ... # 입력으로 넣어준 이미지 개수만큼 반복
    },
    "summary": {
        # outputs.mask=True 인 경우에만 존재
        "distribution_of_prediction": ndarray(uint8, shape=(H, W, 3)),  # mask의 분포를 jet colormap으로 시각화한 이미지
        "class_{idx}_distribution_of_prediction": ndarray(uint8, shape=(H, W, 3)),  # mask중 idx 클래스의 분포를 jet colormap으로 시각화한 이미지

        # outputs.mask=True 이면서 labeled=True 인 경우에만 존재
        "pixel/accuracy": float,  # pixel-wise accuracy
        "pixel/mean_iou": float,  # pixel-wise mean iou
        "pixel/class_{idx}_iou": float,  # 각 {idx} class 별 pixel iou

        # outputs.objects=True 이면서 labeled=True 인 경우에만 존재
        "object/accuracy": float,  # object-wise accuracy
        "object/underkill": int,  # 라벨 object 중 검출하지 못한 라벨의 개수 (미검)
        "object/class_{idx}_underkill": int,  # 클래스가 idx인 라벨 object 중 검출하지 못한 라벨의 개수
        "object/overkill": int,  # 예측 object 중 틀린 예측의 개수 (과검)
        "object/class_{idx}_overkill": int,  # 클래스가 idx인 예측 object 중 틀린 예측의 개수
        "object/confusion_matrix": List[List[int]],  # object-wise confusion matrix
            [
                [0, 1, 0, 1],  # 과검. class1로 예측한 과검 1개, class3으로 예측한 과검 1개.
                [1, 2, 0, 0],  # 라벨이 class1인 object 중에 미검 1개, 맞춘 것 2개
                [2, 0, 3, 0],  # 라벨이 class2인 object 중에 미검 2개, 맞춘 것 3개
                ..., # n_classes 만큼 반복
            ]
    },
}

        
    
  

  








analyze_with_existing_data()




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


  Note
  해당 함수는 아래 루틴을 호출하는 것과 동일함:
total_steps = handler.initialize_analysis()  # 초기화
for _ in range(total_steps):
    handler.step_analysis()  # 정해진 수 만큼 스텝 수행
results = handler.finalize_analysis()  # 마무리 & 결과 리턴


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

  








warmup()




  
  
      현재 설정된 inference 옵션을 바탕으로 warmup을 수행합니다.

Inference

`segmentation.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()`

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

Inference

segmentation.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()

`segmentation.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()`