Go to file
dixingxing d3277e37cd
Merge ed0c3ebe17 into d1c5a6e9aa
2025-01-26 23:07:27 +00:00
.github [Docs] Update ISSUE_TEMPLATE docs for github. (#793) 2023-04-03 15:40:17 +08:00
addons [Distributed] Update SparseOperationKit to v23.5.01 and docker file. (#866) 2023-05-23 13:50:54 +08:00
cibuild [Dockerfile] Add DeepRec release image dockerfile. (#976) 2024-02-28 17:18:29 +08:00
docs Merge ed0c3ebe17 into d1c5a6e9aa 2025-01-26 23:07:27 +00:00
modelzoo [Embedding] Check the sharded property of tf.train.Saver. (#996) 2024-05-23 12:00:02 +08:00
serving [Serving] Fix syntax error in generate timeline tool. (#977) 2024-02-29 10:10:38 +08:00
tensorflow [Embedding] Fix op dependency in init_from_checkpoint API. (#1012) 2025-01-21 17:54:28 +08:00
third_party [Allocator] Optimize EV allocator performance. (#893) 2023-06-16 10:47:10 +08:00
tools [Quantization] Fix bug: reserve input nodes, clear saver devices on demand. (#873) 2023-05-29 19:27:01 +08:00
.bazelrc [BUILD] Override default java toolchain to remove -parameters flag. 2023-04-04 15:09:16 +08:00
.bazelversion [BUILD] Upgrade default BAZEL version to 5.3.1. 2023-03-16 17:33:42 +08:00
.gitignore Make git ignore more files 2021-06-24 13:14:07 +08:00
ACKNOWLEDGMENTS
ADOPTERS.md
AUTHORS Format AUTHORS file (#14881) 2017-11-29 16:02:05 -08:00
BUILD Export 'configure' and 'configure.py' to allow inverse dependent repos to do 'bazel run @org_tensorflow//:configure -- --workspace $(pwd)'. 2018-11-02 01:29:58 -07:00
CODE_OF_CONDUCT.md [Doc] Update docs. (#120) 2022-03-17 17:55:55 +08:00
COMMITTERS.md [Docs] Update COMMITTERS.md. 2023-06-09 09:32:16 +08:00
CONTRIBUTING.md [Docs] Add Developer Certificate of Origin (DCO) in CONTRIBUTING.md. (#847) 2023-05-06 17:24:05 +08:00
GOVERNANCE.md [Docs] Add COMMITTERS.md and GOVERNANCE.md. 2023-03-30 18:11:52 +08:00
ISSUES.md Fix minor errors in ISSUES.md 2019-06-04 13:28:03 -07:00
ISSUE_TEMPLATE.md [Doc] Update docs. (#120) 2022-03-17 17:55:55 +08:00
LICENSE revert line 1 2019-06-12 23:34:10 -07:00
README.md [Docs] Update deeprec2402 release images and notes in README.md & RELEASE.md. (#975) 2024-02-28 16:57:59 +08:00
RELEASE.md [Docs] Update deeprec2402 release images and notes in README.md & RELEASE.md. (#975) 2024-02-28 16:57:59 +08:00
WORKSPACE [BUILD] Move thirdparties from WORKSPACE to workspace.bzl. 2023-04-14 17:31:02 +08:00
arm_compiler.BUILD Switch Raspberry Pi building to unofficial GCC 6.5 toolchain 2020-05-12 10:05:23 +09:00
configure [Serving] Fix serving build break. (#133) 2022-03-26 01:02:02 +08:00
configure.cmd build: introduce `configure.cmd` 2019-06-21 09:39:00 -07:00
configure.py [Embedding] Add interface of EmbeddingVar for Elastic Training. (#933) 2023-10-26 19:02:41 +08:00
models.BUILD Make models.BUILD filegroup include everything but metadata files and archives. 2017-01-10 14:25:53 -08:00

README.md

DeepRec Logo


Introduction

DeepRec is a high-performance recommendation deep learning framework based on TensorFlow 1.15, Intel-TensorFlow and NVIDIA-TensorFlow. It is hosted in incubation in LF AI & Data Foundation.

Background

Recommendation models have huge commercial values for areas such as retailing, media, advertisements, social networks and search engines. Unlike other kinds of models, recommendation models have large amount of non-numeric features such as id, tag, text and so on which lead to huge parameters.

DeepRec has been developed since 2016, which supports core businesses such as Taobao Search, recommendation and advertising. It precipitates a list of features on basic frameworks and has excellent performance in recommendation models training and inference. So far, in addition to Alibaba Group, dozens of companies have used DeepRec in their business scenarios.

Key Features

DeepRec has super large-scale distributed training capability, supporting recommendation model training of trillion samples and over ten trillion parameters. For recommendation models, in-depth performance optimization has been conducted across CPU and GPU platform. It contains list of features to improve usability and performance for super-scale scenarios.

Embedding & Optimizer

  • Embedding Variable.
  • Dynamic Dimension Embedding Variable.
  • Adaptive Embedding Variable.
  • Multiple Hash Embedding Variable.
  • Multi-tier Hybrid Embedding Storage.
  • Group Embedding.
  • AdamAsync Optimizer.
  • AdagradDecay Optimizer.

Training

  • Asynchronous Distributed Training Framework (Parameter Server), such as grpc+seastar, FuseRecv, StarServer etc.
  • Synchronous Distributed Training Framework (Collective), such as HybridBackend, Sparse Operation Kits (SOK) etc.
  • Runtime Optimization, such as Graph Aware Memory Allocator (GAMMA), Critical-path based Executor etc.
  • Runtime Optimization (GPU), GPU Multi-Stream Engine which support multiple CUDA compute stream and CUDA Graph.
  • Operator level optimization, such as BF16 mixed precision optimization, embedding operator optimization and EmbeddingVariable on PMEM and GPU, new hardware feature enabling, etc.
  • Graph level optimization, such as AutoGraphFusion, SmartStage, AutoPipeline, Graph Template Engine, Sample-awared Graph Compression, MicroBatch etc.
  • Compilation optimization, support BladeDISC, XLA etc.

Deploy and Serving

  • Delta checkpoint loading and exporting.
  • Super-scale recommendation model distributed serving.
  • Multi-tier hybrid storage and multi backend supported.
  • Online deep learning with low latency.
  • High performance inference framework SessionGroup (share-nothing), with multiple threadpool and multiple CUDA stream supported.
  • Model Quantization.

Installation

Prepare for installation

CPU Platform

alideeprec/deeprec-build:deeprec-dev-cpu-py38-ubuntu20.04

GPU Platform

alideeprec/deeprec-build:deeprec-dev-gpu-py38-cu116-ubuntu20.04

How to Build

Configure

$ ./configure

Compile for CPU and GPU defaultly

$ bazel build -c opt --config=opt //tensorflow/tools/pip_package:build_pip_package

Compile for CPU and GPU: ABI=0

$ bazel build --cxxopt="-D_GLIBCXX_USE_CXX11_ABI=0" --host_cxxopt="-D_GLIBCXX_USE_CXX11_ABI=0" -c opt --config=opt //tensorflow/tools/pip_package:build_pip_package

Compile for CPU optimization: oneDNN + Unified Eigen Thread pool

$ bazel build -c opt --config=opt --config=mkl_threadpool //tensorflow/tools/pip_package:build_pip_package

Compile for CPU optimization and ABI=0

$ bazel build --cxxopt="-D_GLIBCXX_USE_CXX11_ABI=0" --host_cxxopt="-D_GLIBCXX_USE_CXX11_ABI=0" -c opt --config=opt --config=mkl_threadpool //tensorflow/tools/pip_package:build_pip_package

Create whl package

$ ./bazel-bin/tensorflow/tools/pip_package/build_pip_package /tmp/tensorflow_pkg

Install whl package

$ pip3 install /tmp/tensorflow_pkg/tensorflow-1.15.5+${version}-cp38-cp38m-linux_x86_64.whl

Latest Release Images

Image for CPU

alideeprec/deeprec-release:deeprec2402-cpu-py38-ubuntu20.04

Image for GPU CUDA11.6

alideeprec/deeprec-release:deeprec2402-gpu-py38-cu116-ubuntu20.04

Continuous Build Status

Official Build

Build Type Status
Linux CPU CPU Build
Linux GPU GPU Build
Linux CPU Serving CPU Serving Build
Linux GPU Serving GPU Serving Build

Official Unit Tests

Unit Test Type Status
Linux CPU C CPU C Unit Tests
Linux CPU CC CPU CC Unit Tests
Linux CPU Contrib CPU Contrib Unit Tests
Linux CPU Core CPU Core Unit Tests
Linux CPU Examples CPU Examples Unit Tests
Linux CPU Java CPU Java Unit Tests
Linux CPU JS CPU JS Unit Tests
Linux CPU Python CPU Python Unit Tests
Linux CPU Stream Executor CPU Stream Executor Unit Tests
Linux GPU C GPU C Unit Tests
Linux GPU CC GPU CC Unit Tests
Linux GPU Contrib GPU Contrib Unit Tests
Linux GPU Core GPU Core Unit Tests
Linux GPU Examples GPU Examples Unit Tests
Linux GPU Java GPU Java Unit Tests
Linux GPU JS GPU JS Unit Tests
Linux GPU Python GPU Python Unit Tests
Linux GPU Stream Executor GPU Stream Executor Unit Tests
Linux CPU Serving UT CPU Serving Unit Tests
Linux GPU Serving UT GPU Serving Unit Tests

User Document

Chinese: https://deeprec.readthedocs.io/zh/latest/

English: https://deeprec.readthedocs.io/en/latest/

Contact Us

Join the Official Discussion Group on DingTalk

Join the Official Discussion Group on WeChat

License

Apache License 2.0