菜单

安装与设置

相关源文件

本页面涵盖了labml_nn库的安装过程和初始设置,该库提供了深度学习论文的带注释实现。有关文档系统本身的信息,请参阅文档系统

labml_nn 包概述

labml_nn包是各种深度学习算法和架构的 PyTorch 实现集合,并带有详细注释。这些实现旨在具有教育意义,并附有解释代码的侧边笔记。

来源: setup.py6-44

安装方法

您可以使用 pip 安装labml_nn包,或者通过克隆存储库并从源代码安装。

使用 pip 安装

最简单的方法是直接从 PyPI 安装

pip install labml-nn

这将安装该包及其所有必需的依赖项。

来源: setup.py6-44

从源代码安装

对于最新版本或用于开发

  1. 克隆仓库

    git clone https://github.com/labmlai/annotated_deep_learning_paper_implementations.git
    
  2. 导航到克隆的目录

    cd annotated_deep_learning_paper_implementations
    
  3. 安装包和依赖项

    pip install -e .
    

-e标志以可编辑模式安装包,这对于开发很有用。

来源: setup.py6-44

依赖项

labml_nn包依赖于其他几个库。以下是需求的细分

核心依赖项

依赖项最低版本目的
torch1.10PyTorch - 深度学习框架
torchvision0.11用于 PyTorch 的计算机视觉工具
torchtext0.11用于 PyTorch 的文本处理工具
labml0.4.147实验跟踪工具包
labml-helpers0.4.84labml 的辅助工具
numpy1.19数值计算
einops0.3.0张量操作简化

可选依赖项

这些依赖项是特定实现所必需的

依赖项用于
matplotlib可视化
gym[atari]强化学习环境
opencv-python计算机视觉处理
Pillow图像处理
faiss高效相似性搜索
fairscale分布式训练

来源: setup.py23-30 requirements.txt1-12

项目结构

使用 labml_nn 代码库时,您会遇到以下目录结构

目录目的
labml_nn/主要实现代码
labml_nn/transformers/Transformer 模型实现
labml_nn/diffusion/Diffusion 模型实现
labml_nn/gan/GAN 实现
labml_nn/rl/强化学习算法
labml_nn/optimizers/优化算法
docs/生成的文档

许多实现都包含 Python notebook 版本,展示了实现的使用方法。

来源: setup.py18-22 .gitignore1-19

设置环境

开发环境设置

如果您打算贡献或修改实现,以下是设置开发环境的方法

  1. 创建并激活虚拟环境(推荐)

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  2. 克隆存储库(如果尚未完成)

    git clone https://github.com/labmlai/annotated_deep_learning_paper_implementations.git
    cd annotated_deep_learning_paper_implementations
    
  3. 安装所有开发依赖项

    pip install -r requirements.txt
    
  4. 以可编辑模式安装包

    pip install -e .
    

来源: setup.py6-44 requirements.txt1-12

配置

您可以选择使用.labml.yaml文件配置跟踪设置。这会影响实验指标的跟踪和日志记录方式。

来源: .labml.yaml1-22

基本用法

安装包后,您可以从库中导入特定的实现。以下是使用方法

大多数实现都包含示例,展示了如何训练和评估模型。

与 labml 集成

labml_nn包与labml包协同工作,后者提供了实验跟踪和日志记录功能。这种集成允许您

  1. 在训练期间跟踪指标
  2. 可视化结果
  3. 保存和加载模型
  4. 生成报告

有关这些功能的更多详细信息,请参阅主文档。

来源: setup.py23-30 .labml.yaml1-22