diff --git a/docs/api/paddle/callbacks/Overview_cn.rst b/docs/api/paddle/callbacks/Overview_cn.rst index 7238cb6199e..b17efabdc74 100644 --- a/docs/api/paddle/callbacks/Overview_cn.rst +++ b/docs/api/paddle/callbacks/Overview_cn.rst @@ -23,3 +23,4 @@ paddle.callbacks 目录下包含飞桨框架支持的回调函数相关的 API " :ref:`ProgBarLogger ` ", "打印损失和评估指标日志回调类" " :ref:`ReduceLROnPlateau ` ", "根据评估指标降低学习率回调函数" " :ref:`VisualDL ` ", "可视化回调函数" + " :ref:`WandbCallback ` ", "将为与'best'训练步骤关联的运行设置摘要指标" diff --git a/docs/api/paddle/callbacks/WandbCallback_cn.rst b/docs/api/paddle/callbacks/WandbCallback_cn.rst new file mode 100644 index 00000000000..182a077c094 --- /dev/null +++ b/docs/api/paddle/callbacks/WandbCallback_cn.rst @@ -0,0 +1,32 @@ +.. _cn_api_paddle_callbacks_WandbCallback: + +WandbCallback +------------------------------- + +.. py:class:: paddle.callbacks.WandbCallback(project=None, entity=None, name=None, dir=None, mode=None, job_type=None, **kwargs) + +使用 `Weights and Biases `_ 跟踪您的训练和系统指标。 + +**安装和设置** +使用 pip 安装并登录您的 W&B 账户: + +.. code-block:: bash + + pip install wandb + wandb login + +参数 +:::::::::::: + + - **project**(str, 可选) - 项目的名称。默认值为 uncategorized + - **entity**(str, 可选) - 创建运行的团队/用户的名称。默认值为已登录的用户 + - **name**(str, 可选) - 运行的名称。默认值为 wandb 随机生成 + - **dir**(str, 可选) - 存储所有元数据的目录。默认值为 `wandb` + - **mode**(str, 可选) - 可以是 "online"、"offline" 或 "disabled"。默认值为 "online". + - **job_type**(str, 可选) - 运行类型,用于将运行分组在一起。默认值为 None + + +代码示例 +:::::::::::: + + COPY-FROM: paddle.callbacks.WandbCallback diff --git a/docs/api/paddle/incubate/nn/functional/variable_length_memory_efficient_attention_cn.rst b/docs/api/paddle/incubate/nn/functional/variable_length_memory_efficient_attention_cn.rst new file mode 100644 index 00000000000..823db6476e5 --- /dev/null +++ b/docs/api/paddle/incubate/nn/functional/variable_length_memory_efficient_attention_cn.rst @@ -0,0 +1,33 @@ +.. _cn_api_paddle_incubate_nn_functional_variable_length_memory_efficient_attention: + +variable_length_memory_efficient_attention +------------------------------- + +.. py:function:: paddle.incubate.nn.functional.variable_length_memory_efficient_attention(query, key, value, seq_lens, kv_seq_lens, mask=None, scale=None, causal=False, pre_cache_length=0) + +Cutlass Memory Efficient Variable Attention。 +这个方法需要 SM_ARCH 在 sm70, sm75, sm80 中。 + +参数 +:::::::::::: + + - **query** (Tensor) - 查询张量。形状为 [batchsize, seq_len, num_head, head_size]. + - **key** (Tensor) - 关键张量。形状为 [batchsize, seq_len, num_head, head_size]. + - **value** (Tensor) - 值张量。形状为 [batchsize, seq_len, num_head, head_size]. + - **seq_lens** (Tensor) - 批处理中序列的序列长度,用于索引查询。形状为 [batchsize, 1]. + - **kv_seq_lens** (Tensor) - 批处理中序列的序列长度,用于索引键和值。形状为 [batchsize, 1]. + - **mask** (Tensor) - 掩码张量。形状为 [batchsize, 1, query_seq_len, key_seq_len]. + - **scale** (Float) - 注意力矩阵的刻度。默认值为 sqrt (1.0 / head_size). + - **causal** (Bool) - 是否使用因果掩码。默认值为 False. + - **pre_cache_length** (Int) - 预缓存的长度。默认值为 0. + + +返回 +:::::::::::: + Tensor: 输出张量。 + + +代码示例 +:::::::::::: + + COPY-FROM: paddle.callbacks.WandbCallback diff --git a/docs/api/paddle/profiler/SummaryView_cn.rst b/docs/api/paddle/profiler/SummaryView_cn.rst index 782420e35f2..2c3a912f619 100644 --- a/docs/api/paddle/profiler/SummaryView_cn.rst +++ b/docs/api/paddle/profiler/SummaryView_cn.rst @@ -3,7 +3,7 @@ SummaryView --------------------- -.. py:class:: paddle.profiler.SummaryView +.. py:class:: paddle.profiler.SummaryView(value) SummaryView 枚举类用来表示数据表单的类型。