다음을 통해 공유

ExplanationClient 클래스

  • 참조

설명을 업로드 및 다운로드하는 클라이언트를 정의합니다.

설명 및 실행 기록과 상호 작용하는 데 사용되는 클라이언트를 만듭니다.

상속
builtins.object
ExplanationClient

생성자

ExplanationClient(service_context, experiment_name, run_id, _run=None, datastore_name=None)

매개 변수

Name Description
service_context
필수
<xref:ServiceContext>

서비스 정보 표시자입니다.
run_id
필수
str

실행을 나타내는 GUID입니다.
_run
Run

실행입니다. 전달되면 다른 인수는 무시됩니다.

기본값: None
service_context
필수
<xref:ServiceContext>

서비스 정보 표시자입니다.
run_id
필수
str

실행을 나타내는 GUID입니다.
_run
필수
Run

실행입니다. 전달되면 run_id 무시됩니다.
datastore_name
str

업로드에 사용할 데이터 저장소의 이름(기본값은 작업 영역 저장소)

기본값: None
experiment_name
필수

메서드

download_model_explanation

실행 기록에 저장된 모델 설명을 다운로드합니다.
from_run

실행이 주어진 팩터리 메서드로 클라이언트를 작성합니다.
from_run_id

실행 ID가 지정된 팩터리 메서드로 클라이언트를 작성합니다.
list_model_explanations

사용 가능한 모든 모델 설명에 대한 메타데이터 사전을 반환합니다.
upload_model_explanation

실행 기록에 대한 모델 설명 정보를 업로드합니다.

download_model_explanation

실행 기록에 저장된 모델 설명을 다운로드합니다.

download_model_explanation(explanation_id=None, top_k=None, comment=None, raw=None, engineered=None)

매개 변수

Name Description
explanation_id
str

지정된 경우 지정된 설명 ID를 사용하여 실행에서 자산을 다운로드하려고 시도합니다. 지정하지 않으면 가장 최근에 업로드된 설명을 반환합니다.

기본값: None
top_k
int

지정된 경우 가장 중요한 기능 및 값으로 반환되는 정렬된 데이터를 제한합니다. 이 경우 global_importance_values 및 per_class_values는 정렬되지 않은 값의 일반적인 전체 목록 대신 상위 k개의 정렬된 값이 포함되어 있습니다.

기본값: None
comment
str

업로드된 문자열을 기반으로 설명을 필터링하는 데 사용되는 문자열입니다. 정확히 일치해야 합니다. 여러 설명이 이 문자열을 공유하는 경우 가장 최근의 설명이 반환됩니다.

기본값: None
raw
bool 또는 None

True 또는 False인 경우 설명이 원시 여부에 따라 필터링됩니다. 아무 것도 지정하지 않으면 이 필터가 적용되지 않습니다.

기본값: None
engineered
bool 또는 None

True 또는 False인 경우 설명은 엔지니어링 여부에 따라 필터링됩니다. 아무 것도 지정하지 않으면 이 필터가 적용되지 않습니다.

기본값: None

반환

형식 Description
<xref:interpret_community.explanation.explanation.BaseExplanation>

실행 기록에 업로드된 설명입니다.

from_run

실행이 주어진 팩터리 메서드로 클라이언트를 작성합니다.

from_run(run, datastore_name=None)

매개 변수

Name Description
cls
필수
ExplanationClient

ExplanationClient 클래스입니다.
run
필수
Run

실행 설명이 첨부됩니다.
datastore_name
str

업로드에 사용할 데이터 저장소의 이름(기본값은 작업 영역 저장소)

기본값: None

반환

형식 Description
ExplanationClient

ExplanationClient의 인스턴스입니다.

from_run_id

실행 ID가 지정된 팩터리 메서드로 클라이언트를 작성합니다.

from_run_id(workspace, experiment_name, run_id, datastore_name=None)

매개 변수

Name Description
cls
필수
ExplanationClient

ExplanationClient 클래스입니다.
workspace
필수
Workspace

작업 영역을 나타내는 개체입니다.
experiment_name
필수
str

실험의 이름입니다.
run_id
필수
str

실행을 나타내는 GUID입니다.
datastore_name
str

업로드에 사용할 데이터 저장소의 이름(기본값은 작업 영역 저장소)

기본값: None

반환

형식 Description
ExplanationClient

ExplanationClient의 인스턴스입니다.

list_model_explanations

사용 가능한 모든 모델 설명에 대한 메타데이터 사전을 반환합니다.

list_model_explanations(comment=None, raw=None, engineered=None)

매개 변수

Name Description
comment
str

업로드된 문자열을 기반으로 설명을 필터링하는 데 사용되는 문자열입니다. 정확히 일치해야 합니다.

기본값: None
raw
bool 또는 None

True 또는 False인 경우 설명이 원시 여부에 따라 필터링됩니다. 아무 것도 지정하지 않으면 이 필터가 적용되지 않습니다.

기본값: None
engineered
bool 또는 None

True 또는 False인 경우 설명은 엔지니어링 여부에 따라 필터링됩니다. 아무 것도 지정하지 않으면 이 필터가 적용되지 않습니다.

기본값: None

반환

형식 Description
dict

ID, 데이터 형식, 설명 메서드, 모델 형식 및 업로드 시간과 같은 설명 메타데이터의 사전으로 업로드 시간별로 정렬됩니다.

upload_model_explanation

실행 기록에 대한 모델 설명 정보를 업로드합니다.

upload_model_explanation(explanation, max_num_blocks=None, block_size=None, top_k=None, comment=None, init_dataset_id=None, eval_dataset_id=None, ys_pred_dataset_id=None, ys_pred_proba_dataset_id=None, upload_datasets=False, model_id=None, true_ys=None, visualization_points=5000) -> None

매개 변수

Name Description
explanation
필수
<xref:interpret_community.explanation.explanation.BaseExplanation>

저장할 설명 정보입니다.
max_num_blocks
int

저장할 최대 블록 수입니다.

기본값: None
block_size
int

아티팩트 스토리지에 저장된 요약에 대한 각 블록의 크기입니다.

기본값: None
top_k
int

설명에 저장된 중요한 기능의 수입니다. 지정된 경우 상위 K개의 가장 중요한 기능에 해당하는 이름과 값만 반환/저장됩니다. 이 경우 global_importance_values 및 per_class_values는 정렬되지 않은 값의 일반적인 전체 목록 대신 상위 k개의 정렬된 값이 포함되어 있습니다.

기본값: None
comment
str

설명을 식별하기 위한 선택적 문자열입니다. 설명을 나열할 때 문자열이 표시되어 업로드된 설명을 식별할 수 있습니다.

기본값: None
init_dataset_id
str

사용 가능한 경우 데이터 세트 서비스의 초기화(백그라운드) 데이터 세트 ID입니다. 설명을 데이터 세트에 연결하는 데 사용됩니다.

기본값: None
eval_dataset_id
str

사용 가능한 경우 데이터 세트 서비스에 있는 평가 데이터 세트의 ID입니다. 설명을 데이터 세트에 연결하는 데 사용됩니다.

기본값: None
ys_pred_dataset_id
str

사용 가능한 경우 데이터 세트 서비스의 예측 값 데이터 세트 ID입니다.

기본값: None
ys_pred_proba_dataset_id
str

사용 가능한 경우 데이터 세트 서비스에서 예측된 확률 값 데이터 세트의 ID입니다.

기본값: None
upload_datasets
bool

True로 설정하고 데이터 세트 ID가 전달되지 않으면 평가 데이터 세트가 Azure Storage에 데이터 세트 개체로 업로드됩니다. 이렇게 하면 설명이 웹 보기의 데이터 세트에 연결될 수 있습니다.

기본값: False
model_id
str

MMS 모델 ID입니다.

기본값: None
true_ys
list | <xref:pandas.Dataframe> | ndarray

평가 예에 대한 실제 레이블입니다.

기본값: None
visualization_points
int 또는 list[int]

정수로 설정하면 웹 UI에서 시각화에 사용할 수 있는 포인트 수의 상한선입니다. 정수 목록으로 설정하면 이 정수는 웹 UI에서 시각화할 포인트 샘플(원본 데이터 및 설명)을 선택하기 위한 인덱스로 사용됩니다. 웹 UI에서 설명을 볼 계획이 없다면 이 매개 변수를 0으로 설정할 수 있으며 추가 계산이나 스토리지가 발생하지 않습니다.

정수 또는 목록 길이의 상한선은 현재 20000(2만)입니다. 더 큰 정수 또는 더 긴 목록이 전달되는 경우 함수는 실패합니다. 성능상의 이유로 웹 UI에 입력되는 데이터의 양을 제한하기 위한 것입니다. 더 많은 평가를 통해 이 제한이 높아질 수 있습니다.

기본값: 5000

특성

run

설명 클라이언트에서 실행을 가져옵니다.

반환

형식 Description
Run

실행 개체입니다.