|
2 | 2 | API 文档 |
3 | 3 | ================== |
4 | 4 |
|
5 | | -欢迎使用飞桨框架(PaddlePaddle), PaddlePaddle 是一个易用、高效、灵活、可扩展的深度学习框架,致力于让深度学习技术的创新与应用更简单。 |
| 5 | +欢迎使用飞桨框架(PaddlePaddle),PaddlePaddle 是一个易用、高效、灵活、可扩展的深度学习框架,致力于让深度学习技术的创新与应用更简单。 |
6 | 6 |
|
7 | 7 | 在本版本中,飞桨框架对 API 做了许多优化,您可以参考下表来了解飞桨框架最新版的 API 目录结构与说明。更详细的说明,请参见 `版本说明 <../release_note_cn.html>`_ 。此外,您可参考 PaddlePaddle 的 `GitHub <https://github.com/PaddlePaddle/Paddle>`_ 了解详情。 |
8 | 8 |
|
9 | | -**注: paddle.fluid.\*, paddle.dataset.\* 会在未来的版本中废弃,请您尽量不要使用这两个目录下的 API。** |
| 9 | +**注: paddle.fluid.\*、paddle.dataset.\* 会在未来的版本中废弃,请您尽量不要使用这两个目录下的 API。** |
10 | 10 |
|
11 | | -+-------------------------------+-------------------------------------------------------+ |
12 | | -| 目录 | 功能和包含的 API | |
13 | | -+===============================+=======================================================+ |
14 | | -| paddle.\* | paddle | |
15 | | -| | 根目录下保留了常用 API 的别名,包括:paddle.tensor, | |
16 | | -| | paddle.framework, paddle.device 目录下的所有 API | |
17 | | -+-------------------------------+-------------------------------------------------------+ |
18 | | -| paddle.tensor | Tensor 操作相关的 API,包括 创建 zeros, | |
19 | | -| | 矩阵运算 matmul, 变换 concat, 计算 add, 查找 argmax 等 | |
20 | | -+-------------------------------+-------------------------------------------------------+ |
21 | | -| paddle.framework | 框架通用 API 和动态图模式的 API,包括 no_grad 、 | |
22 | | -| | save 、 load 等。 | |
23 | | -+-------------------------------+-------------------------------------------------------+ |
24 | | -| paddle.device | 设备管理相关 API,包括 set_device, get_device 等。 | |
25 | | -+-------------------------------+-------------------------------------------------------+ |
26 | | -| paddle.linalg | 线性代数相关 API,包括 det, svd 等。 | |
27 | | -+-------------------------------+-------------------------------------------------------+ |
28 | | -| paddle.fft | 快速傅里叶变换的相关 API,包括 fft, fft2 等。 | |
29 | | -+-------------------------------+-------------------------------------------------------+ |
30 | | -| paddle.amp | 自动混合精度策略,包括 auto_cast 、 | |
31 | | -| | GradScaler 等。 | |
32 | | -+-------------------------------+-------------------------------------------------------+ |
33 | | -| paddle.autograd | 自动求导相关 API,包括 backward、PyLayer 等。 | |
34 | | -+-------------------------------+-------------------------------------------------------+ |
35 | | -| paddle.callbacks | 日志回调类,包括 ModelCheckpoint 、 | |
36 | | -| | ProgBarLogger 等。 | |
37 | | -+-------------------------------+-------------------------------------------------------+ |
38 | | -| paddle.distributed | 分布式相关基础 API。 | |
39 | | -+-------------------------------+-------------------------------------------------------+ |
40 | | -| paddle.distributed.fleet | 分布式相关高层 API。 | |
41 | | -+-------------------------------+-------------------------------------------------------+ |
42 | | -| paddle.hub | 模型拓展相关的 API,包括 list、load、help 等。 | |
43 | | -+-------------------------------+-------------------------------------------------------+ |
44 | | -| paddle.io | 数据输入输出相关 API,包括 Dataset, DataLoader 等。 | |
45 | | -+-------------------------------+-------------------------------------------------------+ |
46 | | -| paddle.jit | 动态图转静态图相关 API,包括 to_static、 | |
47 | | -| | ProgramTranslator、TracedLayer 等。 | |
48 | | -+-------------------------------+-------------------------------------------------------+ |
49 | | -| paddle.metric | 评估指标计算相关的 API,包括 Accuracy, Auc 等。 | |
50 | | -+-------------------------------+-------------------------------------------------------+ |
51 | | -| paddle.nn | 组网相关的 API,包括 Linear 、卷积 Conv2D 、 | |
52 | | -| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss 、 | |
53 | | -| | 激活函数 ReLU 等。 | |
54 | | -+-------------------------------+-------------------------------------------------------+ |
55 | | -| paddle.onnx | paddle 转换为 onnx 协议相关 API,包括 export 等。 | |
56 | | -+-------------------------------+-------------------------------------------------------+ |
57 | | -| paddle.optimizer | 优化算法相关 API,包括 SGD,Adagrad, Adam 等。 | |
58 | | -+-------------------------------+-------------------------------------------------------+ |
59 | | -| paddle.optimizer.lr | 学习率衰减相关 API,包括 NoamDecay 、 StepDecay 、 | |
60 | | -| | PiecewiseDecay 等。 | |
61 | | -+-------------------------------+-------------------------------------------------------+ |
62 | | -| paddle.regularizer | 正则化相关 API,包括 L1Decay、L2Decay 等。 | |
63 | | -+-------------------------------+-------------------------------------------------------+ |
64 | | -| paddle.static | 静态图下基础框架相关 API,包括 Variable, Program, | |
65 | | -| | Executor 等 | |
66 | | -+-------------------------------+-------------------------------------------------------+ |
67 | | -| paddle.static.nn | 静态图下组网专用 API,包括 全连接层 fc 、控制流 | |
68 | | -| | while_loop/cond 。 | |
69 | | -+-------------------------------+-------------------------------------------------------+ |
70 | | -| paddle.text | NLP 领域 API,包括 NLP 领域相关的数据集, | |
71 | | -| | 如 Imdb 、 Movielens 。 | |
72 | | -+-------------------------------+-------------------------------------------------------+ |
73 | | -| paddle.utils | 工具类相关 API,包括 CppExtension、CUDAExtension 等。 | |
74 | | -+-------------------------------+-------------------------------------------------------+ |
75 | | -| paddle.vision | 视觉领域 API,包括 数据集 Cifar10 、数据处理 | |
76 | | -| | ColorJitter、常用基础网络结构 ResNet 等。 | |
77 | | -+-------------------------------+-------------------------------------------------------+ |
78 | | -| paddle.sparse | 稀疏领域的 API。 | |
79 | | -+-------------------------------+-------------------------------------------------------+ |
| 11 | ++--------------------------+----------------------------------------------------------+ |
| 12 | +| 目录 | 功能和包含的 API | |
| 13 | ++==========================+==========================================================+ |
| 14 | +| paddle.\* | paddle | |
| 15 | +| | 根目录下保留了常用 API 的别名,包括:paddle.tensor、 | |
| 16 | +| | paddle.framework、paddle.device 目录下的所有 API。 | |
| 17 | ++--------------------------+----------------------------------------------------------+ |
| 18 | +| paddle.tensor | Tensor 操作相关的 API,包括 创建 zeros, | |
| 19 | +| | 矩阵运算 matmul,变换 concat,计算 add,查找 argmax 等。 | |
| 20 | ++--------------------------+----------------------------------------------------------+ |
| 21 | +| paddle.framework | 框架通用 API 和动态图模式的 API,包括 no_grad、 | |
| 22 | +| | save、load 等。 | |
| 23 | ++--------------------------+----------------------------------------------------------+ |
| 24 | +| paddle.device | 设备管理相关 API,包括 set_device、get_device 等。 | |
| 25 | ++--------------------------+----------------------------------------------------------+ |
| 26 | +| paddle.linalg | 线性代数相关 API,包括 det、svd 等。 | |
| 27 | ++--------------------------+----------------------------------------------------------+ |
| 28 | +| paddle.fft | 快速傅里叶变换的相关 API,包括 fft、fft2 等。 | |
| 29 | ++--------------------------+----------------------------------------------------------+ |
| 30 | +| paddle.amp | 自动混合精度策略,包括 auto_cast、 | |
| 31 | +| | GradScaler 等。 | |
| 32 | ++--------------------------+----------------------------------------------------------+ |
| 33 | +| paddle.autograd | 自动求导相关 API,包括 backward、PyLayer 等。 | |
| 34 | ++--------------------------+----------------------------------------------------------+ |
| 35 | +| paddle.callbacks | 日志回调类,包括 ModelCheckpoint、 | |
| 36 | +| | ProgBarLogger 等。 | |
| 37 | ++--------------------------+----------------------------------------------------------+ |
| 38 | +| paddle.distributed | 分布式相关基础 API。 | |
| 39 | ++--------------------------+----------------------------------------------------------+ |
| 40 | +| paddle.distributed.fleet | 分布式相关高层 API。 | |
| 41 | ++--------------------------+----------------------------------------------------------+ |
| 42 | +| paddle.hub | 模型拓展相关的 API,包括 list、load、help 等。 | |
| 43 | ++--------------------------+----------------------------------------------------------+ |
| 44 | +| paddle.io | 数据输入输出相关 API,包括 Dataset、DataLoader 等。 | |
| 45 | ++--------------------------+----------------------------------------------------------+ |
| 46 | +| paddle.jit | 动态图转静态图相关 API,包括 to_static、 | |
| 47 | +| | ProgramTranslator、TracedLayer 等。 | |
| 48 | ++--------------------------+----------------------------------------------------------+ |
| 49 | +| paddle.metric | 评估指标计算相关的 API,包括 Accuracy、Auc 等。 | |
| 50 | ++--------------------------+----------------------------------------------------------+ |
| 51 | +| paddle.nn | 组网相关的 API,包括 Linear、卷积 Conv2D、 | |
| 52 | +| | 循环神经网络 RNN、损失函数 CrossEntropyLoss、 | |
| 53 | +| | 激活函数 ReLU 等。 | |
| 54 | ++--------------------------+----------------------------------------------------------+ |
| 55 | +| paddle.onnx | paddle 转换为 onnx 协议相关 API,包括 export 等。 | |
| 56 | ++--------------------------+----------------------------------------------------------+ |
| 57 | +| paddle.optimizer | 优化算法相关 API,包括 SGD,Adagrad、Adam 等。 | |
| 58 | ++--------------------------+----------------------------------------------------------+ |
| 59 | +| paddle.optimizer.lr | 学习率衰减相关 API,包括 NoamDecay、StepDecay、 | |
| 60 | +| | PiecewiseDecay 等。 | |
| 61 | ++--------------------------+----------------------------------------------------------+ |
| 62 | +| paddle.regularizer | 正则化相关 API,包括 L1Decay、L2Decay 等。 | |
| 63 | ++--------------------------+----------------------------------------------------------+ |
| 64 | +| paddle.static | 静态图下基础框架相关 API,包括 Variable、Program、 | |
| 65 | +| | Executor 等。 | |
| 66 | ++--------------------------+----------------------------------------------------------+ |
| 67 | +| paddle.static.nn | 静态图下组网专用 API,包括 全连接层 fc、控制流 | |
| 68 | +| | while_loop/cond。 | |
| 69 | ++--------------------------+----------------------------------------------------------+ |
| 70 | +| paddle.text | NLP 领域 API,包括 NLP 领域相关的数据集, | |
| 71 | +| | 如 Imdb、Movielens。 | |
| 72 | ++--------------------------+----------------------------------------------------------+ |
| 73 | +| paddle.utils | 工具类相关 API,包括 CppExtension、CUDAExtension 等。 | |
| 74 | ++--------------------------+----------------------------------------------------------+ |
| 75 | +| paddle.vision | 视觉领域 API,包括 数据集 Cifar10、数据处理 | |
| 76 | +| | ColorJitter、常用基础网络结构 ResNet 等。 | |
| 77 | ++--------------------------+----------------------------------------------------------+ |
| 78 | +| paddle.sparse | 稀疏领域的 API。 | |
| 79 | ++--------------------------+----------------------------------------------------------+ |
0 commit comments