########  ##       ##              ##
                                ##     ## ##       ##    ##        ##
                                ##     ## ##       ##    ##        ##
                       **$**    ##     ## ##       ##    ##        ##    **$**
                                ##     ## ##       ######### ##    ##
                                ##     ## ##             ##  ##    ##
                                ########  ########       ##   ######
              .   :::: :   :    :   :     : ::::  :     ::::    :::::  :::: ::::  :::::   .
              .   :    :   :   : :  ::   :: :   : :     :       :   :  :    :   : :   :   .
              .   :     : :   :   : : : : : :   : :     :       :   :  :    :   : :   :   .
              .   :::    :    :   : :  :  : ::::  :     :::     :::::  :::  ::::  :   :   .
              .   :     : :   ::::: :     : :     :     :       :  :   :    :     :   :   .
              .   :    :   :  :   : :     : :     :     :       :   :  :    :     :   :   .
              .   :::: :   :  :   : :     : :     ::::: ::::    :    : :::: :     :::::   .

如需支持，请访问： https://community.konduit.ai

我们不会经常查看此仓库的 GitHub 问题。

简介

Eclipse Deeplearning4J（DL4J）生态系统是一组项目，旨在满足基于 JVM 的深度学习应用的所有需求。这意味着从原始数据开始，无论其来源和格式如何，都可以对其进行加载和预处理，进而构建和调优各种简单或复杂的深度学习网络。

DL4J 技术栈包括：

• DL4J：用于构建多层网络和计算图的高级 API，支持多种层类型，包括自定义层。它能够导入 Keras 模型（h5 格式），包括 tf.keras 模型（自 1.0.0-M2 版本起），并支持在 Apache Spark 上进行分布式训练。
• ND4J：通用线性代数库，提供超过 500 种数学、线性代数和深度学习运算。ND4J 基于高度优化的 C++ 库 LibND4J，支持 CPU（AVX2/512）和 GPU（CUDA），并通过 OpenBLAS、OneDNN（MKL-DNN）、cuDNN、cuBLAS 等库实现加速。
• SameDiff：作为 ND4J 库的一部分，SameDiff 是我们的自动微分/深度学习框架。SameDiff 采用基于图的方式（先定义后运行），类似于 TensorFlow 的图模式。计划支持急切执行模式（TensorFlow 2.x 急切模式/PyTorch）。SameDiff 支持导入 TensorFlow 冻结模型格式 .pb（protobuf）。未来还将支持导入 ONNX、TensorFlow SavedModel 和 Keras 模型。Deeplearning4j 还完全支持 SameDiff，方便用户轻松编写自定义层和损失函数。
• DataVec：用于机器学习数据的 ETL 工具，支持多种格式和文件类型（HDFS、Spark、图像、视频、音频、CSV、Excel 等）。
• LibND4J：支撑所有组件的 C++ 库。有关 JVM 如何访问原生数组和操作的更多信息，请参阅 JavaCPP。

DL4J 生态系统中的所有项目均支持 Windows、Linux 和 macOS。硬件方面支持 CUDA GPU（10.0、10.1、10.2，但不包括 OSX）、x86 CPU（x86_64、avx2、avx512）、ARM CPU（arm、arm64、armhf）以及 PowerPC（ppc64le）。

先决条件

本示例仓库由多个独立的 Maven Java 项目组成，每个项目都有自己的 pom 文件。Maven 是一种流行的 Java 项目构建自动化工具。“pom.xml” 文件的内容决定了项目的配置。有关如何配置 Maven 的更多信息，请参阅 这里。

用户也可以参考提供的简单示例项目，从头开始创建一个干净的新项目。

构建工具被认为是软件工程中的最佳实践。此外，由于 DL4J 生态系统中各项目的复杂性，手动管理依赖关系会非常困难。DL4J 生态系统中的所有项目也可以与其他构建工具（如 Gradle、SBT 等）一起使用。更多相关信息请参阅 这里。

支持

如需示例方面的帮助，请访问我们的支持论坛。

请注意：对于使用 1.0.0-beta7 及更早版本的用户，部分示例和模块已被移除，以反映框架发展方向的变化。请参阅并评论我们的帖子这里。

如果您希望找到某种缺失功能的替代方案，欢迎在论坛上发帖，我们将尽力为您提供帮助。

示例内容

项目是根据其中包含的示例向用户展示的功能来划分的，而不一定取决于该功能具体位于 DL4J 技术栈中的哪个库。

项目中的示例通常分为“快速入门”和“进阶”两类。

每个项目的 README 文件也会列出其所包含的所有示例，并推荐一个探索这些示例的顺序。

• dl4j-examples 该项目包含一组示例，展示了如何使用 DL4J 的高级 API 构建各种神经网络。其中一些示例是端到端的，即从原始数据开始，经过数据处理后构建并训练神经网络。

• tensorflow-keras-import-examples 该项目包含一组示例，演示如何将 Keras 的 h5 模型和 TensorFlow 的冻结 pb 模型导入 DL4J 生态系统。一旦导入 DL4J，这些模型就可以像其他 DL4J 模型一样被处理——也就是说，你可以继续对它们进行训练，或使用迁移学习 API 对其进行修改，也可以直接运行推理。

• dl4j-distributed-training-examples 该项目包含一组示例，演示如何在 Apache Spark 上使用 DL4J 进行分布式训练、推理和评估。DL4J 的分布式训练采用一种“混合”异步 SGD 方法——更多细节请参阅分布式深度学习文档 此处。

• cuda-specific-examples 该项目包含一组示例，演示如何利用多块 GPU 进行数据并行训练，以提升神经网络的性能。

• samediff-examples 该项目包含一组示例，演示 SameDiff API 的用法。SameDiff（属于 ND4J 库的一部分）可用于构建更底层的自动微分计算图。SameDiff API 与 DL4J API 的关系，类似于低级 TensorFlow API 与更高抽象层次的 Keras API 之间的关系。

• data-pipeline-examples 该项目包含一组示例，演示如何加载、拆分和预处理各种格式的原始数据，从而构建可序列化的（进而可复现的）ETL 流水线。

• nd4j-ndarray-examples 该项目包含一组示例，展示如何操作 NDArrays。这里演示的 ND4J 功能可以类比为 NumPy。

• rl4j-examples 该项目包含 RL4J 的使用示例，RL4J 是 DL4J 中的强化学习库。

• android-examples 该项目包含一个 Android 示例项目，展示了 DL4J 在 Android 应用程序中的使用。

反馈与贡献

虽然这组示例并未涵盖 DL4J 的所有功能，但其目标是覆盖大多数用户（无论是初学者还是高级用户）所需的功能。如果您有未在此处涵盖的反馈或功能请求，请在此处提交问题 这里。您也可以通过我们的 社区论坛 提出问题。 我们欢迎社区的贡献。更多信息请参阅 [CONTRIBUTORS.md]。 我们非常乐意听取您的意见。祝好！

Deeplearning4j Examples 快速上手指南

本指南旨在帮助中国开发者快速了解并运行 deeplearning4j-examples 项目，掌握 Eclipse Deeplearning4J (DL4J) 生态系统的核心功能。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

系统要求

• 操作系统：Windows、Linux 或 macOS。
• 硬件支持：
  • CPU: x86_64 (支持 AVX2/AVX512), ARM (arm, arm64, armhf), PowerPC (ppc64le)。
  • GPU: 如需使用 CUDA 加速，需配备 NVIDIA GPU (支持 CUDA 10.0, 10.1, 10.2，macOS 除外)。

前置依赖

• JDK: 建议安装 JDK 8 或更高版本。
• Maven: 本项目基于 Maven 构建，请确保已安装 Apache Maven (推荐 3.6+)。
  • 检查安装：mvn -v
• 构建工具知识: 熟悉 Maven 的 pom.xml 配置是管理 DL4J 复杂依赖的关键。虽然也支持 Gradle 和 SBT，但本示例仓库主要提供 Maven 配置。

提示：国内开发者若遇到 Maven 依赖下载缓慢的问题，建议在 ~/.m2/settings.xml 中配置阿里云镜像源以加速构建。

安装步骤

本项目由多个独立的 Maven 子项目组成，每个子项目都有各自的 pom.xml。您可以选择克隆整个仓库或单独获取感兴趣的模块。

1. 克隆仓库

git clone https://github.com/eclipse/deeplearning4j-examples.git
cd deeplearning4j-examples

2. 编译项目

进入您想要运行的具体示例目录（例如 dl4j-examples），执行以下命令进行编译和依赖下载：

cd dl4j-examples
mvn clean compile

如果您想从头开始创建一个干净的项目，可以参考仓库中的模板：

# 查看模板配置
cat mvn-project-template/pom.xml

3. 运行示例

编译成功后，您可以直接通过 Maven 运行特定的示例类。通常示例类位于 src/main/java 目录下。

# 示例：运行一个具体的类（请将 <ClassName> 替换为实际类名）
mvn exec:java -Dexec.mainClass="org.deeplearning4j.examples.<ClassName>"

或者在您的 IDE（如 IntelliJ IDEA 或 Eclipse）中导入该 Maven 项目，直接运行对应的 main 方法。

基本使用

DL4J 生态系统包含多个模块，针对不同需求提供了丰富的示例。以下是几个核心模块的最简使用场景：

1. 构建神经网络 (dl4j-examples)

这是最常用的高层 API 示例集，展示了如何从零开始加载数据、预处理并训练多层网络 (MultiLayerNetwork) 或计算图 (ComputationGraph)。

• 适用场景：初学者入门，端到端的深度学习流程。
• 操作：进入 dl4j-examples 目录，寻找标记为 "quickstart" 的示例（如 MLPClassifierLinear），直接运行即可观察模型训练过程。

2. 导入 Keras/TensorFlow 模型 (tensorflow-keras-import-examples)

如果您已有训练好的 Keras (.h5) 或 TensorFlow Frozen (.pb) 模型，可以使用此模块将其导入 DL4J。

• 适用场景：模型迁移，利用 Java 生态进行推理或微调 (Transfer Learning)。
• 核心代码逻辑：

  // 伪代码示例：导入 Keras 模型
  KerasModelImport.importKerasSequentialModelAndWeights("model.h5");
  // 导入后可像普通 DL4J 模型一样进行 inference 或 fine-tuning
  

3. 分布式训练 (dl4j-distributed-training-examples)

展示如何在 Apache Spark 上进行分布式训练、推理和评估。

• 适用场景：大数据集处理，需要利用集群资源加速训练。
• 特点：采用混合异步 SGD (Stochastic Gradient Descent) 方法。

4. 数据处理管道 (data-pipeline-examples)

使用 DataVec 组件处理各种格式（CSV, 图像，音频等）的原始数据，构建可序列化的 ETL 管道。

• 适用场景：数据清洗、格式化及预处理，确保实验可复现。

5. 底层张量操作 (nd4j-ndarray-examples)

类似于 Python 的 NumPy，ND4J 提供了强大的多维数组操作能力。

• 适用场景：自定义数学运算，底层算法研究。
• 类比：如果你熟悉 NumPy，这里的 INDArray 操作逻辑非常相似。

---

获取更多帮助： 由于 GitHub Issues 监控频率较低，如遇具体问题或需要讨论高级用法，请访问官方社区论坛：https://community.konduit.ai