メインコンテンツへスキップ

API 概要


Source

class DisplayNameFuncError


Source

class OpCallError


Source

class OpKwargs

op() のキーワード引数用の TypedDict です。
Source

class Sentinel

Sentinel(package: ‘str’, path: ‘str’, name: ‘str’) Source

method __init__

__init__(package: 'str', path: 'str', name: 'str') → None

Source

class WeaveKwargs


Source

function as_op

as_op(fn: 'Callable[P, R]') → Op[P, R]
@weave.op でデコレートされた関数が与えられた場合、その Op を返します。 @weave.op でデコレートされた関数はすでに Op のインスタンスであるため、この関数は実行時には no-op(何もしない操作)となるはずです。しかし、型安全な方法で OpDef 属性にアクセスする必要がある場合に、型チェッカーを満足させるために使用できます。 引数:
  • fn: weave.op でデコレートされた関数。 結果: 関数の Op

Source

function call

call(
    op: 'Op',
    *args: 'Any',
    __weave: 'WeaveKwargs | None' = None,
    __should_raise: 'bool' = False,
    __require_explicit_finish: 'bool' = False,
    **kwargs: 'Any'
) → tuple[Any, Call] | Coroutine[Any, Any, tuple[Any, Call]]
op を実行し、その 結果 と実行を表す Call の両方を返します。 この関数は例外を発生させません。エラーが発生した場合は Call オブジェクトに記録されます。 このメソッドは @weave.op でデコレートされた任意の関数に自動的にバインドされ、以下のような使い方が可能です:
@weave.op
def add(a: int, b: int) -> int:
     return a + b

result, call = add.call(1, 2)

Source

function calls

calls(op: 'Op') → CallsIter
この op に対するすべての呼び出し(calls)を反復処理するイテレータを取得します。 このメソッドは @weave.op でデコレートされた任意の関数に自動的にバインドされ、以下のような使い方が可能です:
@weave.op
def add(a: int, b: int) -> int:
     return a + b

calls = add.calls()
for call in calls:
     print(call)

Source

function get_captured_code

get_captured_code(op: 'Op') → str
op のキャプチャされた コード を取得します。 これは ref から op を取得した場合にのみ機能します。パターンは以下の通りです: ref = weave.publish(func) op = ref.get() captured_code = op.get_captured_code()
Source

function is_op

is_op(obj: 'Any') → TypeIs[Op]
オブジェクトが Op であるかどうかを確認します。
Source

function is_placeholder_call

is_placeholder_call(call: 'Call') → TypeIs[NoOpCall]

Source

function is_tracing_setting_disabled

is_tracing_setting_disabled() → bool

Source

function maybe_bind_method

maybe_bind_method(func: 'Callable', self: 'Any' = None) → Callable | MethodType
関数を任意のオブジェクトにバインドします(クラスでなくても可能です)。 selfNone の場合、関数をそのまま返します。
Source

function maybe_unbind_method

maybe_unbind_method(oplike: 'Op | MethodType | partial') → Op
Opライクなメソッドまたは partial を、プレーンな Op 関数にアンバインドします。 対象:
  • メソッドの場合:設定された self パラメータを削除します
  • partial の場合:あらかじめ設定されたパラメータをすべて削除します

Source

function op

op(
    func: 'Callable[P, R] | None' = None,
    name: 'str | None' = None,
    call_display_name: 'str | CallDisplayNameFunc | None' = None,
    postprocess_inputs: 'PostprocessInputsFunc | None' = None,
    postprocess_output: 'PostprocessOutputFunc | None' = None,
    tracing_sample_rate: 'float' = 1.0,
    enable_code_capture: 'bool' = True,
    accumulator: 'Callable[[Any | None, Any], Any] | None' = None,
    kind: 'OpKind | None' = None,
    color: 'OpColor | None' = None
) → Callable[[Callable[P, R]], Op[P, R]] | Op[P, R]
関数またはメソッドを Weave の op に変換するためのデコレータです。同期・非同期の両方に対応しています。イテレータ関数を自動的に検出し、適切な 振る舞い を適用します。
Source

function placeholder_call

placeholder_call() → Call

Source

function setup_dunder_weave_dict

setup_dunder_weave_dict(op: 'Op', d: 'WeaveKwargs | None' = None) → WeaveKwargs
WeaveKwargs を op に渡すために使用される __weave 辞書をセットアップします。 引数:
  • d: 更新対象となる既存の WeaveKwargs 辞書(任意)。
  • op: kindcolor を抽出するための Op結果: attributesdisplay_name 、およびオプションで kind/color が設定された WeaveKwargs 辞書。

Source

function should_skip_tracing_for_op

should_skip_tracing_for_op(op: 'Op') → bool