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オブジェクトを保存してバージョン管理します。 nameという名前のオブジェクトが既に存在し、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参照URI、またはweave.init()が呼び出されている場合は「name:version」または単に「name」(この場合、バージョンには「latest」が使用されます)。
Returns:オブジェクトへのweave Ref。

function get

URIからオブジェクトを取得するための便利な関数。 Weaveによってログ記録されたオブジェクトの多くは、自動的にWeaveサーバーに登録されます。この関数を使用すると、URIでそれらのオブジェクトを取得できます。 Args:
  • uri**: 完全修飾されたweave参照URI。
Returns:オブジェクト。 Example:

function require_current_call

現在実行中のOp内で、そのOpのCallオブジェクトを取得します。 これにより、実行中のCallのIDやフィードバックなどの属性にアクセスできます。
Opが戻った後にCallにアクセスすることも可能です。 CallのID(おそらくUIから)がある場合は、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

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