Skip to main content

API 개요

클래스​

함수​

  • api.init: wandb 프로젝트에 로깅하는 weave 추적 초기화
  • api.publish: Python 객체 저장 및 버전 관리
  • api.ref: Weave 객체에 대한 Ref 구성
  • api.get: URI에서 객체를 가져오기 위한 편의 함수
  • call_context.require_current_call: 현재 실행 중인 Op 내에서 해당 Op의 Call 객체 가져오기
  • call_context.get_current_call: 현재 실행 중인 Op 내에서 해당 Op의 Call 객체 가져오기
  • api.finish: weave 로깅 중지
  • op.op: 함수나 메서드를 weave op로 만드는 데코레이터. 동기 및 비동기 모두 작동
  • api.attributes: 호출에 속성을 설정하기 위한 컨텍스트 관리자

function init​

wandb 프로젝트에 로깅하는 weave 추적 초기화 로깅은 전역적으로 초기화되므로 init의 반환 값에 대한 참조를 유지할 필요가 없습니다. init 이후, weave.op() 데코레이터가 적용된 함수 호출은 지정된 프로젝트에 로깅됩니다. Args:
  • project_name**: 로깅할 Weights & Biases 프로젝트의 이름
  • settings: 일반적인 Weave 클라이언트 구성
  • autopatch_settings: openai와 같은 자동 패치 통합을 위한 구성
  • global_postprocess_inputs: 모든 op의 모든 입력에 적용될 함수
  • global_postprocess_output: 모든 op의 모든 출력에 적용될 함수
  • global_attributes: 모든 추적에 적용될 속성 사전
NOTE: Global postprocessing settings are applied to all ops after each op’s own postprocessing. The order is always: 1. Op-specific postprocessing 2. Global postprocessing Returns:Weave 클라이언트

function publish​

Python 객체 저장 및 버전 관리 이름이 있는 객체가 이미 존재하고 obj의 콘텐츠 해시가 해당 객체의 최신 버전과 일치하지 않는 경우 새 버전이 생성됩니다. TODO: Need to document how name works with this change. Args:
  • obj**: 저장하고 버전 관리할 객체
  • name: 객체를 저장할 이름
Returns:저장된 객체에 대한 weave Ref

function ref​

Weave 객체에 대한 Ref 구성 TODO: what happens if obj does not exist Args:
  • location**: 정규화된 weave ref URI, 또는 weave.init()이 호출된 경우 “name:version” 또는 “name”만 (이 경우 버전은 “latest”가 사용됨)
Returns:객체에 대한 weave Ref

function get​

URI에서 객체를 가져오기 위한 편의 함수 Weave에 의해 로깅된 많은 객체는 자동으로 Weave 서버에 등록됩니다. 이 함수를 사용하면 URI로 해당 객체를 검색할 수 있습니다. Args:
  • uri**: 정규화된 weave ref URI
Returns:객체 Example:

function require_current_call​

현재 실행 중인 Op 내에서 해당 Op의 Call 객체 가져오기 이를 통해 실행 중인 Call의 id나 피드백과 같은 속성에 액세스할 수 있습니다.
Op가 반환된 후에도 Call에 액세스하는 것이 가능합니다. UI에서 가져온 Call의 id가 있는 경우, get_call 메서드를 WeaveClient에서 반환된 weave.init에 사용하여 Call 객체를 검색할 수 있습니다.
또는 Op를 정의한 후 call 메서드를 사용할 수 있습니다. 예:
Returns:현재 실행 중인 Op의 Call 객체 Raises:
  • NoCurrentCallError**: 추적이 초기화되지 않았거나 이 메서드가 Op 외부에서 호출된 경우

function get_current_call​

현재 실행 중인 Op 내에서 해당 Op의 Call 객체 가져오기 Returns:현재 실행 중인 Op의 Call 객체, 또는 추적이 초기화되지 않았거나 이 메서드가 Op 외부에서 호출된 경우 None

function finish​

weave 로깅 중지 finish 이후, weave.op() 데코레이터가 적용된 함수 호출은 더 이상 로깅되지 않습니다. 로깅을 재개하려면 weave.init()을 다시 실행해야 합니다.

function op​

함수나 메서드를 weave op로 만드는 데코레이터. 동기 및 비동기 모두 작동합니다. 반복자 함수를 자동으로 감지하고 적절한 동작을 적용합니다.

function attributes​

호출에 속성을 설정하기 위한 컨텍스트 관리자 속성은 호출이 실행되기 시작하면 불변이 됩니다. 이 컨텍스트 관리자를 사용하여 호출이 시작되기 전에 메타데이터를 제공하세요. Example:

class Object​

Pydantic 필드:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]

classmethod from_uri​

classmethod handle_relocatable_object​

class Dataset​

쉬운 저장과 자동 버전 관리 기능을 갖춘 Dataset 객체 Examples:
Pydantic 필드:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • rows: typing.Union[trace.table.Table, trace.vals.WeaveTable]

method add_rows​

기존 데이터셋에 행을 추가하여 새 데이터셋 버전 생성 전체 데이터셋을 메모리에 로드하지 않고도 대규모 데이터셋에 예제를 추가하는 데 유용합니다. Args:
  • rows**: 데이터셋에 추가할 행
Returns:업데이트된 데이터셋

classmethod convert_to_table​

classmethod from_calls​

classmethod from_obj​

classmethod from_pandas​

method select​

제공된 인덱스를 기반으로 데이터셋에서 행 선택 Args:
  • indices**: 어떤 행을 선택할지 지정하는 정수 인덱스의 반복 가능한 객체
Returns:선택된 행만 포함하는 새 Dataset 객체

method to_pandas​

class Model​

입력에 작용하는 코드와 데이터의 조합을 캡처하기 위한 용도. 예를 들어 예측이나 텍스트 생성을 위해 프롬프트와 함께 LLM을 호출할 수 있습니다. 모델의 속성이나 모델을 정의하는 코드를 변경하면, 이러한 변경 사항이 기록되고 버전이 업데이트됩니다. 이를 통해 서로 다른 모델 버전 간의 예측을 비교할 수 있습니다. 이를 활용하여 프롬프트를 반복적으로 개선하거나 최신 LLM을 시도하고 다양한 설정 간의 예측을 비교할 수 있습니다 Examples:
Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]

method get_infer_method​

class Prompt​

Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]

method format​

class StringPrompt​

method __init__​

Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • content: “

method format​

classmethod from_obj​

class MessagesPrompt​

method __init__​

Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • messages: list[dict]

method format​

method format_message​

classmethod from_obj​

class Evaluation​

평가 세트와 스코러 세트를 포함하는 평가를 설정합니다. evaluation.evaluate(model)을 호출하면 데이터셋의 행을 모델에 전달하며, 데이터셋의 열 이름을 model.predict의 인수 이름과 일치시킵니다. 그런 다음 모든 스코러를 호출하고 결과를 weave에 저장합니다. 데이터셋의 행을 전처리하려면 preprocess_model_input에 함수를 전달할 수 있습니다. Examples:
Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • dataset: “
  • scorers: typing.Optional[list[typing.Annotated[typing.Union[trace.op.Op, flow.scorer.Scorer], BeforeValidator(func=)]]]
  • preprocess_model_input: typing.Optional[typing.Callable[[dict], dict]]
  • trials: “
  • evaluation_name: typing.Union[str, typing.Callable[[trace.weave_client.Call], str], NoneType]

method evaluate​

classmethod from_obj​

method get_eval_results​

method predict_and_score​

method summarize​

class EvaluationLogger​

이 클래스는 평가를 로깅하기 위한 명령형 인터페이스를 제공합니다. 평가는 log_prediction 메서드를 사용하여 첫 번째 예측이 로깅될 때 자동으로 시작되고, log_summary 메서드가 호출될 때 완료됩니다. 예측을 로깅할 때마다 ScoreLogger 객체를 반환받습니다. 이 객체를 사용하여 특정 예측에 대한 점수와 메타데이터를 로깅할 수 있습니다. 자세한 내용은 ScoreLogger 클래스를 참조하세요. Example:
Pydantic Fields:
  • name: str | None
  • model: flow.model.Model | dict | str
  • dataset: flow.dataset.Dataset | list[dict] | str

property ui_url​

method finish​

요약을 로깅하지 않고 평가 리소스를 명시적으로 정리합니다. 모든 예측 호출과 주요 평가 호출이 완료되도록 합니다. 로거가 컨텍스트 관리자로 사용되는 경우 자동으로 호출됩니다.

method log_prediction​

평가에 예측을 로깅하고 참조를 반환합니다. 이 참조는 특정 예측 인스턴스에 연결된 점수를 로깅하는 데 사용할 수 있습니다.

method log_summary​

평가에 요약 딕셔너리를 로깅합니다. 이는 요약을 계산하고, summarize 연산을 호출한 다음, 평가를 완료합니다. 이후에는 더 이상 예측이나 점수를 로깅할 수 없습니다.

class Scorer​

Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • column_map: typing.Optional[dict[str, str]]

method model_post_init​

method score​

method summarize​

class AnnotationSpec​

Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • field_schema: dict[str, typing.Any]
  • unique_among_creators: “
  • op_scope: typing.Optional[list[str]]

classmethod preprocess_field_schema​

classmethod validate_field_schema​

method value_is_valid​

이 주석 스펙의 스키마에 대해 페이로드를 검증합니다. Args:
  • payload**: 스키마에 대해 검증할 데이터
Returns:
  • bool: 검증이 성공하면 True, 그렇지 않으면 False

class File​

경로, MIME 타입 및 크기 정보가 포함된 파일을 나타내는 클래스입니다.

method __init__​

File 객체를 초기화합니다. Args:
  • path**: 파일 경로(문자열 또는 pathlib.Path)
  • mimetype: 선택적 파일 MIME 타입 - 제공되지 않은 경우 확장자에서 유추됨

property filename​

파일의 파일명을 가져옵니다. Returns:
  • str: 디렉토리 경로 없이 파일 이름만 반환합니다.

method open​

운영 체제의 기본 애플리케이션을 사용하여 파일을 엽니다. 이 메서드는 플랫폼별 메커니즘을 사용하여 파일 유형과 연결된 기본 애플리케이션으로 파일을 엽니다. Returns:
  • bool**: 파일이 성공적으로 열렸으면 True, 그렇지 않으면 False.

method save​

파일을 지정된 대상 경로로 복사합니다. Args:
  • dest**: 파일이 복사될 대상 경로(문자열 또는 pathlib.Path) 대상 경로는 파일 또는 디렉토리일 수 있습니다.

class Markdown​

마크다운 렌더링 가능 객체입니다. Args:
  • markup (str): 마크다운이 포함된 문자열입니다.
  • code_theme (str, optional): 코드 블록용 Pygments 테마입니다. 기본값은 “monokai”입니다.
  • justify (JustifyMethod, optional): 단락의 정렬 값입니다. 기본값은 None입니다.
  • style (Union[str, Style], optional): 마크다운에 적용할 선택적 스타일입니다.
  • hyperlinks (bool, optional): 하이퍼링크를 활성화합니다. 기본값은 True.
  • inline_code_lexer: (str, optional): 인라인 코드 강조가 활성화된 경우 사용할 렉서입니다. 기본값은 None입니다.
  • inline_code_theme: (Optional[str], optional): 인라인 코드 강조를 위한 Pygments 테마, 또는 강조 없음을 위한 None. 기본값은 None.

method __init__​

class Monitor​

들어오는 호출을 자동으로 점수화하는 모니터를 설정합니다. Examples:
Pydantic Fields:
  • name: typing.Optional[str]
  • description: typing.Optional[str]
  • ref: typing.Optional[trace.refs.ObjectRef]
  • sampling_rate: “
  • scorers: list[flow.scorer.Scorer]
  • op_names: list[str]
  • query: typing.Optional[trace_server.interface.query.Query]
  • active: “

method activate​

모니터를 활성화합니다. Returns: 모니터에 대한 참조.

method deactivate​

모니터를 비활성화합니다. Returns: 모니터에 대한 참조.

classmethod from_obj​

class SavedView​

SavedView 객체로 작업하기 위한 유창한 스타일의 클래스.

method __init__​

property entity​

property label​

property project​

property view_type​

method add_column​

method add_columns​

그리드에 여러 열을 추가하기 위한 편의 메서드.

method add_filter​

method add_sort​

method column_index​

method filter_op​

method get_calls​

이 저장된 뷰의 필터와 설정에 맞는 호출을 가져옵니다.

method get_known_columns​

존재하는 것으로 알려진 열의 집합을 가져옵니다.

method get_table_columns​

method hide_column​

method insert_column​

classmethod load​

method page_size​

method pin_column_left​

method pin_column_right​

method remove_column​

method remove_columns​

저장된 뷰에서 열을 제거합니다.

method remove_filter​

method remove_filters​

저장된 뷰에서 모든 필터를 제거합니다.

method rename​

method rename_column​

method save​

저장된 뷰를 서버에 게시합니다.

method set_columns​

그리드에 표시할 열을 설정합니다.

method show_column​

method sort_by​

method to_grid​

method to_rich_table_str​

method ui_url​

UI에서 이 저장된 뷰를 보여주는 URL. 이는 뷰 객체의 URL이 아닌 트레이스 등이 있는 “결과” 페이지임을 참고하세요.

method unpin_column​

class Audio​

지원되는 형식(wav 또는 mp3)의 오디오 데이터를 나타내는 클래스. 이 클래스는 오디오 데이터 저장을 처리하고 다양한 소스에서 로드하고 파일로 내보내는 메서드를 제공합니다. Attributes:
  • format**: 오디오 형식(현재 ‘wav’ 또는 ‘mp3’ 지원)
  • data: 바이트로 된 원시 오디오 데이터
Args:
  • data: 오디오 데이터(바이트 또는 base64 인코딩된 문자열)
  • format: 오디오 형식(‘wav’ 또는 ‘mp3’)
  • validate_base64: 입력 데이터의 base64 디코딩 시도 여부
Raises:
  • ValueError: 오디오 데이터가 비어 있거나 형식이 지원되지 않는 경우

method __init__​

method export​

오디오 데이터를 파일로 내보냅니다. Args:
  • path**: 오디오 파일이 작성될 경로

classmethod from_data​

원시 데이터와 지정된 형식에서 Audio 객체를 생성합니다. Args:
  • data**: 바이트 또는 base64 인코딩된 문자열로 된 오디오 데이터
  • format: 오디오 형식(‘wav’ 또는 ‘mp3’)
Returns:
  • Audio: 새 Audio 인스턴스
Raises:
  • ValueError: 형식이 지원되지 않는 경우

classmethod from_path​

파일 경로에서 Audio 객체를 생성합니다. Args:
  • path**: 오디오 파일 경로(.wav 또는 .mp3 확장자를 가져야 함)
Returns:
  • Audio: 파일에서 로드된 새 Audio 인스턴스
Raises:
  • ValueError: 파일이 존재하지 않거나 지원되지 않는 확장자를 가진 경우
이 페이지 편집마지막 업데이트: Jul 14, 2025