getting_started.md

# 开始使用
---
请事先参考[安装指南](install.md)配置运行环境
有关模型库的基本信息请参考[README](https://github.com/PaddlePaddle/PaddleClas/blob/master/README.md)。

## 一、设置环境变量

**设置PYTHONPATH环境变量：**

```bash
export PYTHONPATH=path_to_PaddleClas:$PYTHONPATH
```

## 二、模型训练与评估

PaddleClas 提供模型训练与评估脚本：tools/train.py和tools/eval.py

### 2.1 模型训练
以flower102数据为例按如下方式启动模型训练，flower数据集准备请参考[数据集准备](./data.md)。

```bash
# PaddleClas通过launch方式启动多卡多进程训练
# 通过设置FLAGS_selected_gpus 指定GPU运行卡号

python -m paddle.distributed.launch \
    --selected_gpus="0,1,2,3" \
    --log_dir=log_ResNet50_vd \
    tools/train.py \
        -c ./configs/flower.yaml 
```

- 输出日志示例如下：

```
epoch:0    train    step:13    loss:7.9561    top1:0.0156    top5:0.1094    lr:0.100000    elapse:0.193
```

可以通过添加-o参数来更新配置：

```bash
python -m paddle.distributed.launch \
    --selected_gpus="0,1,2,3" \
    --log_dir=log_ResNet50_vd \
    tools/train.py \
        -c ./configs/flower.yaml \
        -o use_mix=1 

```

- 输出日志示例如下：

```
epoch:0    train    step:522    loss:1.6330    lr:0.100000    elapse:0.210
```

或是直接修改模型对应的yaml配置文件，具体配置参数参考[配置文档](config.md)。

### 2.3 模型微调

以ResNet50_vd和ResNet50_vd_ssld预训练模型对flower102数据集进行微调。

ResNet50_vd： 在ImageNet1k数据集上训练 top1 acc：79.1% 模型详细信息参考[模型库](https://paddleclas.readthedocs.io/zh_CN/latest/models/ResNet_and_vd.html)。

ResNet50_vd_ssld： 在ImageNet1k数据集训练的蒸馏模型 top1： 82.4% 模型详细信息参考[模型库](https://paddleclas.readthedocs.io/zh_CN/latest/models/ResNet_and_vd.html)。

flower数据集相关信息参考[数据文档](data.md)。

指定pretrained_model参数初始化预训练模型
ResNet50_vd：

```bash
python -m paddle.distributed.launch \
    --selected_gpus="0" \
    tools/train.py \
        -c ./configs/finetune/ResNet50_vd_finetune.yaml
        -o pretrained_model=path_to_ResNet50_vd_pretrained_models
```

ResNet50_vd_ssld：

```bash
python -m paddle.distributed.launch \
    --selected_gpus="0" \
    tools/train.py \
        -c ./configs/finetune/ResNet50_vd_ssld_finetune.yaml
        -o pretrained_model=path_to_ResNet50_vd_ssld_pretrained_models
```


在使用ResNet50_vd预训练模型对flower102数据进行模型微调后，top1 acc 达到 92.71%。
在使用ResNet50_vd_ssld预训练模型对flower102数据进行模型微调后，top1 acc 达到94.96%。


### 2.2 模型评估

```bash
python tools/eval.py \
    -c ./configs/eval.yaml \
    -o architecture="ResNet50_vd" \
    -o pretrained_model=path_to_pretrained_models
```
您可以更改configs/eval.yaml中的architecture字段和pretrained_model字段来配置评估模型，或是通过-o参数更新配置。

## 三、模型推理

PaddlePaddle提供三种方式进行预测推理，接下来介绍如何用预测引擎进行推理：
首先，对训练好的模型进行转换：
```bash
python tools/export_model.py \
    -model=模型名字 \
    -pretrained_model=预训练模型路径 \
    -output_path=预测模型保存路径

```
之后，通过预测引擎进行推理：
```bash
python tools/infer/predict.py \
    -m model文件路径 \
    -p params文件路径 \
    -i 图片路径 \
    --use_gpu=1 \
    --use_tensorrt=True
```
更多使用方法和推理方式请参考[分类预测框架](../extension/paddle_inference.md)。