FATE —— 二.2.3 Homo-NN自定义损失函数

前言

当Pytorch的内置损失功能不能满足您的使用需求时，您可以使用自定义损失来训练您的模型

MNIST示例的一个小问题

您可能会注意到，在上一个教程“自定义数据集”中的MNIST示例中，分类器输出分数是Softmax函数的结果，我们使用torch内置的CrossEntropyLoss来计算损失。然而，它在文档（CrossEntropyLoss Doc）中显示，输入预期包含每个类的未规范化逻辑，也就是说，在该示例中，我们计算Softmax两次。为了解决这个问题，我们可以使用定制的CrossEntropyLoss。

开发自定义丢失

Customized Loss是torch.nn.Module的子类并实现forward函数的类。在FATE训练器中，损失函数将传递两个参数：预测分数和标签（loss_fn（pred，loss）），因此当您使用FATE的训练器时，损失函数需要将两个参数作为输入（预测分数&标签）。然而，如果您使用的是自己的培训师，并且定义了自己的培训流程，那么您不受如何使用损失函数的限制。

一种新的交叉熵损失

在这里，我们实现了一个新的CrossEntropyLoss，它跳过了softmax计算。我们可以使用jupyter接口save_to_rate将代码更新为federatedml.nn.loss（名为ce.py），当然，您可以手动将代码文件复制到目录中。

import torch as t
from federatedml.util import consts
from torch.nn.functional import one_hot


def cross_entropy(p2, p1, reduction='mean'):
    p2 = p2 + consts.FLOAT_ZERO  # to avoid nan
    assert p2.shape == p1.shape
    if reduction == 'sum':
        return -t.sum(p1 * t.log(p2))
    elif reduction == 'mean':
        return -t.mean(t.sum(p1 * t.log(p2), dim=1))
    elif reduction == 'none':
        return -t.sum(p1 * t.log(p2), dim=1)
    else:
        raise ValueError('unknown reduction')


class CrossEntropyLoss(t.nn.Module):

    """
    A CrossEntropy Loss that will not compute Softmax
    """

    def __init__(self, reduction='mean'):
        super(CrossEntropyLoss, self).__init__()
        self.reduction = reduction

    def forward(self, pred, label):

        one_hot_label = one_hot(label.flatten())
        loss_ = cross_entropy(pred, one_hot_label, self.reduction)

        return loss_

训练新的损失

导入组件

import torch as t
from torch import nn
from pipeline import fate_torch_hook
from pipeline.component import HomoNN
from pipeline.backend.pipeline import PipeLine
from pipeline.component import Reader, Evaluation, DataTransform
from pipeline.interface import Data, Model

t = fate_torch_hook(t)

将数据路径绑定到名称和命名空间

import os
# bind data path to name & namespace
# fate_project_path = os.path.abspath('../')
arbiter = 10000
host = 10000
guest = 9999
pipeline = PipeLine().set_initiator(role='guest', party_id=guest).set_roles(guest=guest, host=host,
                                                                            arbiter=arbiter)

data_0 = {"name": "mnist_guest", "namespace": "experiment"}
data_1 = {"name": "mnist_host", "namespace": "experiment"}
# 路径根据自己得文件位置及名称进行调整，这里以FATE 1.10.0 版本为例
data_path_0 = '/mnt/hgfs/mnist/'
data_path_1 = '/mnt/hgfs/mnist/'
pipeline.bind_table(name=data_0['name'], namespace=data_0['namespace'], path=data_path_0)
pipeline.bind_table(name=data_1['name'], namespace=data_1['namespace'], path=data_path_1)

{'namespace': 'experiment', 'table_name': 'mnist_host'}

reader_0 = Reader(name="reader_0")
reader_0.get_party_instance(role='guest', party_id=guest).component_param(table=data_0)
reader_0.get_party_instance(role='host', party_id=host).component_param(table=data_1)

使用CustLoss

在fate_torch_hook之后，我们可以使用t.nn.CustLoss指定您自己的损失。我们将在参数中指定模块名和类名，后面是损失类的初始化参数。初始化参数必须是JSON可序列化的，否则无法提交此PipeLine。

from pipeline.component.homo_nn import TrainerParam, DatasetParam  # Interface

# your loss class
loss = t.nn.CustLoss(loss_module_name='cross_entropy', class_name='CrossEntropyLoss', reduction='mean')

# our simple classification model:
model = t.nn.Sequential(
    t.nn.Linear(784, 32),
    t.nn.ReLU(),
    t.nn.Linear(32, 10),
    t.nn.Softmax(dim=1)
)

nn_component = HomoNN(name='nn_0',
                      model=model, # model
                      loss=loss,  # loss
                      optimizer=t.optim.Adam(model.parameters(), lr=0.01), # optimizer
                      dataset=DatasetParam(dataset_name='mnist_dataset', flatten_feature=True),  # dataset
                      trainer=TrainerParam(trainer_name='fedavg_trainer', epochs=2, batch_size=1024, validation_freqs=1),
                      torch_seed=100 # random seed
                      )

pipeline.add_component(reader_0)
pipeline.add_component(nn_component, data=Data(train_data=reader_0.output.data))
pipeline.add_component(Evaluation(name='eval_0', eval_type='multi'), data=Data(data=nn_component.output.data))

pipeline.compile()
pipeline.fit()

pipeline.get_component('nn_0').get_output_data()

pipeline.get_component('nn_0').get_summary()

{'best_epoch': 1,

'loss_history': [3.472281552891043, 2.6957144274613256],

'metrics_summary': {'train': {'accuracy': [0.41711229946524064,

0.6348357524828113],

'precision': [0.5812903622442052, 0.7334376862468294],

'recall': [0.39894927536231883, 0.6243379446640317]}},

'need_stop': False}