# recommender

**Repository Path**: shaw_zhang/recommender

## Basic Information

- **Project Name**: recommender
- **Description**: MindSpore large-scale recommender system library
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 9
- **Created**: 2022-10-12
- **Last Updated**: 2022-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# recommender

### 介绍

recommender仓旨在提供主流推荐网络模型高效训练的解决方案及流程指导，训练方案结合了昇思MindSpore自动并行、图算融合及多级Embedding Cache等能力；我们提供了开箱即用的数据集下载与转换工具、模型训练样例、BenchMark复现，降低开发者入门门槛。

### 仓库结构 

```bash
└── recommender
    ├── benchmarks            // 推荐网络训练性能benchmarks
    ├── datasets              // 数据集下载与转换工具
    ├── mindspore_rec         // 推荐网络训练相关API
    │   └── train
    ├── models                // 典型推荐网络模型端到端训练指导
    │   ├── deep_and_cross
    │   └── wide_deep
    ├── README.md
    ├── build.sh
    └── setup.py
```

### 模型库

模型逐步迁移中，目前[models](models)目录包含Wide&Deep、Deep&Cross Network(DCN)模型的端到端训练流程使用指导，直接下载recommender源码即可使用，无需编译构建。训练不同模型会有少量的Python依赖包需要安装，详见各个模型目录中的requirements.txt


### 安装说明

如果需要使用在线训练能力，需要构建安装recommender。

**1.克隆代码**

```bash
git clone https://gitee.com/mindspore/recommender.git
cd recommender
```

**2.构建安装**

```bash
bash build.sh
pip install output/mindspore_rec-{recommender_version}-py3-none-any.whl
```

**使用样例**

```bash
from mindspore_rec import RecModel as Model
#model定义同mindspore.model
...
model.online_train(self, train_dataset, callbacks=None, dataset_sink_mode=True)
...
```


### 社区
#### 治理
查看MindSpore如何进行[开放治理](https://gitee.com/mindspore/community/blob/master/governance.md)。

### 参与贡献

欢迎参与贡献。更多详情，请参阅我们的[贡献者Wiki](https://gitee.com/mindspore/mindspore/blob/master/CONTRIBUTING.md)。

### 许可证
[Apache License 2.0](https://gitee.com/mindspore/recommender/blob/master/LICENSE)