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

​
API の概要

ソースコード

​
class DisplayNameFuncError

ソースコード

​
class OpCallError

ソースコード

​
class OpKwargs

op() のキーワード引数を表す TypedDict。
ソースコード

​
class Sentinel

Sentinel(package: ‘str’, path: ‘str’, name: ‘str’) ソースコード

​
method __init__

__init__(package: 'str', path: 'str', name: 'str') → None
ソースコード

​
class WeaveKwargs

ソースコード

​
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。
ソースコード

​
関数 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)
ソースコード

​
function calls

calls(op: 'Op') → CallsIter
この op へのすべての呼び出しに対するイテレータを取得します。 このメソッドは @weave.op でデコレートされた関数に自動的にバインドされるため、次のように使用できます： 
@weave.op
def add(a: int, b: int) -> int:
     return a + b

calls = add.calls()
for call in calls:
     print(call)
ソースコード

​
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()
ソースコード

​
function is_op

is_op(obj: 'Any') → TypeIs[Op]
オブジェクトが Op かどうかを判定します。
ソースコード

​
function is_placeholder_call

is_placeholder_call(call: 'Call') → TypeIs[NoOpCall]
ソースコード

​
function is_tracing_setting_disabled

is_tracing_setting_disabled() → bool
ソースコード

​
function maybe_bind_method

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

​
関数 maybe_unbind_method

maybe_unbind_method(oplike: 'Op | MethodType | partial') → Op
Op のようなメソッドまたは partial のバインドを解除し、プレーンな Op 関数にします。 対象:
  • メソッドの場合: バインドされている self パラメータを取り除く
  • partial の場合: あらかじめ指定されているパラメータを取り除く
ソースコード

​
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 に変換するデコレータ。同期処理と非同期処理の両方で動作します。イテレータ関数を自動的に検出し、適切な動作を適用します。
ソースコード

​
function placeholder_call

placeholder_call() → Call
ソースコード

​
function setup_dunder_weave_dict

setup_dunder_weave_dict(op: 'Op', d: 'WeaveKwargs | None' = None) → WeaveKwargs
WeaveKwargs を ops に渡すために使用する __weave dict を設定します。 引数:
  • d: 更新対象となる省略可能な既存の WeaveKwargs dict。
  • op: kind と color を抽出する対象の Op。
戻り値: attributes、display_name、および必要に応じて kind/color が設定された WeaveKwargs dict を返します。
ソースコード

​
関数 should_skip_tracing_for_op

should_skip_tracing_for_op(op: 'Op') → bool