Documentation Index
Fetch the complete documentation index at: https://wb-21fd5541-feature-automate-reference-docs-generation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
API概要
クラス
-
obj.Object -
dataset.Dataset: 簡単な保存と自動バージョン管理機能を持つDatasetオブジェクト -
model.Model: 入力に対して動作するコードとデータの組み合わせをキャプチャすることを目的としています。 -
prompt.Prompt -
prompt.StringPrompt -
prompt.MessagesPrompt -
eval.Evaluation: 一連のスコアラーとデータセットを含む評価をセットアップします。 -
eval_imperative.EvaluationLogger: このクラスは評価をログに記録するための命令型インターフェースを提供します。 -
scorer.Scorer -
annotation_spec.AnnotationSpec -
file.File: パス、MIMEタイプ、サイズ情報を持つファイルを表すクラス。 -
markdown.Markdown: Markdownでレンダリング可能なオブジェクト。 -
monitor.Monitor: 着信呼び出しを自動的にスコアリングするモニターをセットアップします。 -
saved_view.SavedView: SavedViewオブジェクトを操作するためのフルエントスタイルのクラス。 -
audio.Audio: サポートされている形式(wavまたはmp3)のオーディオデータを表すクラス。
関数
-
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
-
project_name**: ログを記録するWeights & Biasesプロジェクトの名前。 -
settings: Weaveクライアント全般の設定。 -
autopatch_settings: openaiなどの自動パッチ統合の設定 -
global_postprocess_inputs: すべてのopのすべての入力に適用される関数。 -
global_postprocess_output: すべてのopのすべての出力に適用される関数。 -
global_attributes: すべてのトレースに適用される属性の辞書。
function publish
-
obj**: 保存してバージョン管理するオブジェクト。 -
name: オブジェクトを保存する名前。
function ref
location**: 完全修飾されたweave参照URI、またはweave.init()が呼び出されている場合は「name:version」または単に「name」(この場合、バージョンには「latest」が使用されます)。
function get
uri**: 完全修飾されたweave参照URI。
function require_current_call
get_callメソッドをWeaveClientから返されたweave.initで使用してCallオブジェクトを取得できます。
callメソッドを使用できます。例えば:
NoCurrentCallError**: トラッキングが初期化されていない場合、またはこのメソッドがOp外で呼び出された場合。
function get_current_call
function finish
function op
function attributes
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:
-
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
rows**: データセットに追加する行。
classmethod convert_to_table
classmethod from_calls
classmethod from_obj
classmethod from_pandas
method select
indices**: 選択する行を指定する整数インデックスの反復可能オブジェクト。
method to_pandas
class Model
入力に対して動作するコードとデータの組み合わせをキャプチャすることを目的としています。例えば、予測やテキスト生成を行うためにプロンプトを使用してLLMを呼び出すことがあります。
モデルの属性や定義するコードを変更すると、これらの変更がログに記録され、バージョンが更新されます。これにより、異なるバージョンのモデル間で予測を比較することができます。これを使用してプロンプトを反復的に改善したり、最新のLLMを試して異なる設定間で予測を比較したりすることができます
Examples:
-
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__
-
name:typing.Optional[str] -
description:typing.Optional[str] -
ref:typing.Optional[trace.refs.ObjectRef] -
content: “
method format
classmethod from_obj
class MessagesPrompt
method __init__
-
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:
-
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:
-
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
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
payload**: スキーマに対して検証するデータ
bool: 検証が成功した場合はTrue、そうでない場合はFalse
class File
パス、MIMEタイプ、サイズ情報を持つファイルを表すクラス。
method __init__
-
path**: ファイルへのパス(文字列またはpathlib.Path) -
mimetype: ファイルのオプションのMIMEタイプ - 提供されない場合は拡張子から推測されます
property filename
ファイルのファイル名を取得します。 Returns:str: ディレクトリパスを除いたファイルの名前。
method open
bool**: ファイルが正常に開かれた場合はTrue、そうでない場合はFalse。
method save
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:
-
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
method deactivate
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
method unpin_column
class Audio
サポートされている形式(wavまたはmp3)のオーディオデータを表すクラス。
このクラスはオーディオデータの保存を処理し、さまざまなソースからの読み込みやファイルへのエクスポートのためのメソッドを提供します。
Attributes:
-
format**: オーディオ形式(現在は「wav」または「mp3」をサポート) -
data: 生のオーディオデータ(バイト形式)
-
data: オーディオデータ(バイトまたはbase64エンコードされた文字列) -
format: オーディオ形式(「wav」または「mp3」) -
validate_base64: 入力データのbase64デコードを試みるかどうか
ValueError: オーディオデータが空または形式がサポートされていない場合
method __init__
method export
path**: オーディオファイルを書き込むパス
classmethod from_data
-
data**: バイトまたはbase64エンコードされた文字列としてのオーディオデータ -
format: オーディオ形式(「wav」または「mp3」)
Audio: 新しいAudioインスタンス
ValueError: 形式がサポートされていない場合
classmethod from_path
path**: オーディオファイルへのパス(.wavまたは.mp3拡張子が必要)
Audio: ファイルから読み込まれた新しいAudioインスタンス
ValueError: ファイルが存在しないか、サポートされていない拡張子を持つ場合