迁移学习源码全注释 - 《Tensorflow 实战 Google 深度学习框架》源码注释

学习迁移学习源码，做了完全版本注释，以做记录：

# -*- coding: utf-8 -*-
"""
Created on Mon Dec 25 12:30:25 2017
需要提前下载训练好的 Inception-V3模型，以及对应的数据文件

@author: Administrator
"""


import glob 
import os.path
import random
import numpy as np
import tensorflow as tf
from tensorflow.python.platform import gfile




# 模型和样本路径的设置
BOTTLENECK_TENSOR_SIZE = 2048
# Google 训练好的模型输出结果张量的名称：pool_3/_reshape:0
BOTTLENECK_TENSOR_NAME = 'pool_3/_reshape:0'
# 图像输入张量对应的名称
JPEG_DATA_TENSOR_NAME = 'DecodeJpeg/contents:0'
# 训练好的Inception-v3模型存放目录
MODEL_DIR = './datasets/inception_dec_2015'
# 训练好的Inception-v3模型文件名称
MODEL_FILE= 'tensorflow_inception_graph.pb'
# 保存通过 Inception-3 计算得到的特征向量文件
CACHE_DIR = './datasets/bottleneck'
# 存放花图片文件夹，每个花类别一个文件夹
INPUT_DATA = './datasets/flower_photos'
# 验证数据百分比
VALIDATION_PERCENTAGE = 10
# 测试数据百分比
TEST_PERCENTAGE = 10




# 神经网络参数的设置
LEARNING_RATE = 0.01
STEPS = 4000
BATCH = 100




# 把样本中所有的图片列表并按训练、验证、测试数据分开
def create_image_lists(testing_percentage, validation_percentage):


    result = {}
    
    # os.walk 取得所有目录和文件：
    # 6*3结构，6：.目录+5个花类别目录，3:当前目录，当前目录子目录，当前目录下文件列表
    # x[0]:x本身代表行，x【0】取得每行的第一个元素，即取得所有一级子目录，第一个是当前目录 "."
    
    sub_dirs = [x[0] for x in os.walk(INPUT_DATA)]
    is_root_dir = True
    for sub_dir in sub_dirs:
        if is_root_dir:
            is_root_dir = False
            continue


        extensions = ['jpg', 'jpeg', 'JPG', 'JPEG']


        file_list = []
        dir_name = os.path.basename(sub_dir)
        for extension in extensions:
            file_glob = os.path.join(INPUT_DATA, dir_name, '*.' + extension)
            # 取得 file_glob 所有文件
            file_list.extend(glob.glob(file_glob))
        if not file_list: continue


        label_name = dir_name.lower()
        
        # 初始化
        training_images = []
        testing_images = []
        validation_images = []
        for file_name in file_list:
            base_name = os.path.basename(file_name)
            
            # 随机划分数据
            chance = np.random.randint(100)
            if chance < validation_percentage:
                validation_images.append(base_name)
            elif chance < (testing_percentage + validation_percentage):
                testing_images.append(base_name)
            else:
                training_images.append(base_name)


        # result 结构：{'花类别1'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},
        #              '花类别2'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},
        #              '花类别3'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},        
        #              }
        result[label_name] = {
            'dir': dir_name,
            'training': training_images,
            'testing': testing_images,
            'validation': validation_images,
            }
    return result




#  定义函数通过类别名称、所属数据集和图片编号获取一张图片的地址
#  image_lists 就是上面函数返回的 result
#  category 是指：training， testing, validation 3个类别中的1个
#  image_index = random.randrange(65536),对应这里的 index, 所以要 index %
def get_image_path(image_lists, image_dir, label_name, index, category):
    # label_lists:某个花类别对应的{'dir':dir_name,'training':[],'testing':[],'validation':[]}
    label_lists = image_lists[label_name]
    # category_list: 某个类别下的图像列表[]
    category_list = label_lists[category]
    # mode_index: 某个图像的编号
    mod_index = index % len(category_list)
    # base_name: 根据图像编号取得对应图像
    base_name = category_list[mod_index]
    # 取得花类别目录
    sub_dir = label_lists['dir']
    # full_path:根目录+花类别目录+图像名称
    full_path = os.path.join(image_dir, sub_dir, base_name)
    return full_path






# 定义函数获取Inception-v3模型处理之后的特征向量的文件地址
def get_bottleneck_path(image_lists, label_name, index, category):
    # get_image_path :根目录+花类别目录+图像名称.txt
    return get_image_path(image_lists, CACHE_DIR, label_name, index, category) + '.txt'




# 定义函数使用加载的训练好的Inception-v3模型处理一张图片，得到这个图片的特征向量。
def run_bottleneck_on_image(sess, image_data, image_data_tensor, bottleneck_tensor):


    bottleneck_values = sess.run(bottleneck_tensor, {image_data_tensor: image_data})


    bottleneck_values = np.squeeze(bottleneck_values)
    return bottleneck_values




# 定义函数会先试图寻找已经计算且保存下来的特征向量，如果找不到则先计算这个特征向量，然后保存到文件。
def get_or_create_bottleneck(sess, image_lists, label_name, index, category, jpeg_data_tensor, bottleneck_tensor):
    # label_lists 是某一个花类别的图片数据
    label_lists = image_lists[label_name]
    # sub_dir 是花类别的目录名称，就是花名
    sub_dir = label_lists['dir']
    # sub_dir_path：'./datasets/bottleneck/花名'
    sub_dir_path = os.path.join(CACHE_DIR, sub_dir)
    if not os.path.exists(sub_dir_path): os.makedirs(sub_dir_path)
    # bottleneck_path: 特征向量 txt 文件路径
    bottleneck_path = get_bottleneck_path(image_lists, label_name, index, category)
    # 如果特征向量不存在
    if not os.path.exists(bottleneck_path):
        # 取得图像文件路径
        image_path = get_image_path(image_lists, INPUT_DATA, label_name, index, category)
        # 读取图像文件，gfile.FastGFile读取图像原始数据，没有解码，不能显示
        image_data = gfile.FastGFile(image_path, 'rb').read()
        # 用训练好的Inception-v3模型处理图片，得到这个图片的特征向量。应该是一个列表，这个函数返回这个特征向量
        # 但是这里要多做一步，把特征向量处理成字符串保存在.txt文件中
        bottleneck_values = run_bottleneck_on_image(sess, image_data, jpeg_data_tensor, bottleneck_tensor)
        # 把列表处理成用','连接的字符串
        bottleneck_string = ','.join(str(x) for x in bottleneck_values)
        # 特征向量字符串写入到文件中
        with open(bottleneck_path, 'w') as bottleneck_file:
            bottleneck_file.write(bottleneck_string)
    else:
        # 如果特征向量存在，是字符串形式，处理成 特征向量形式
        with open(bottleneck_path, 'r') as bottleneck_file:
            bottleneck_string = bottleneck_file.read()
        bottleneck_values = [float(x) for x in bottleneck_string.split(',')]


    # 返回得到的特征向量
    return bottleneck_values




# 这个函数随机获取一个batch的图片作为训练数据。
    # n_classes: 花类别数，image_lists: 总花图片清单，how_many:batch_size,category: test or validation
def get_random_cached_bottlenecks(sess, n_classes, image_lists, how_many, category, jpeg_data_tensor, bottleneck_tensor):
    bottlenecks = []
    ground_truths = []
    for _ in range(how_many):
        # 随机选中一个图像类别的index
        label_index = random.randrange(n_classes)
        label_name = list(image_lists.keys())[label_index]
        # image_index: label_name中的某个图片的 index
        image_index = random.randrange(65536)
        # 返回得到image_index对应图像的特征向量 bottleneck
        bottleneck = get_or_create_bottleneck(
            sess, image_lists, label_name, image_index, category, jpeg_data_tensor, bottleneck_tensor)
        # 建立一个图片类别长度的向量， 并且把随机选到的那个图片对应的向量位置设为1
        ground_truth = np.zeros(n_classes, dtype=np.float32)
        ground_truth[label_index] = 1.0
        # 把这张图片的特征向量加入列表
        bottlenecks.append(bottleneck)
        # 把这个图片的选中类别加入向量，例如[[0,0,0,1,0],[0,0,1,0,0]...] 同时每个向量的编号和向量特征的编号相互对应
        # 比如 bottleneck 中第4个特征向量，对应 ground_truth 中第4个向量中的类别
        ground_truths.append(ground_truth)


    # bottlenecks: 特征向量，[[xxx],[yyy],[zzz]...]
    # groud_truths: 特征向量对应的图片类别向量[[0,0,1,0,0],[0,1,0,0,0],[0,0,0,1,0]...]
    return bottlenecks, ground_truths




# 这个函数获取全部的测试数据，并计算正确率。
def get_test_bottlenecks(sess, image_lists, n_classes, jpeg_data_tensor, bottleneck_tensor):
    bottlenecks = []
    ground_truths = []
    # label_name_list 花类比列表
    label_name_list = list(image_lists.keys())
    # enumerate返回 iterator, 每个元素是一个2元的元祖，(编号，花类别)，编号：0开始的顺序编号
    # 例如：(0,玫瑰)，(1, 桃花).....
    for label_index, label_name in enumerate(label_name_list):
        category = 'testing'
        # 遍历某一个花类别下，某个(训练/验证/测试)类别下的所有图片
        for index, unused_base_name in enumerate(image_lists[label_name][category]):
            # bottleneck 返回图片的特征向量
            bottleneck = get_or_create_bottleneck(sess, image_lists, label_name, index, category,jpeg_data_tensor, bottleneck_tensor)
            ground_truth = np.zeros(n_classes, dtype=np.float32)
            ground_truth[label_index] = 1.0
            bottlenecks.append(bottleneck)
            # ground_truths 类别向量
            ground_truths.append(ground_truth)
            
           #  bottlenecks：特征向量，做输入
           #  ground_truths： 类别向量，做输出。
    return bottlenecks, ground_truths




# 定义主函数。
def main():
    
        #  image_lists结构：{'花类别1'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},
        #                   '花类别2'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},
        #                  '花类别3'：{'dir':dir_name,'training':[],'testing':[],'validation':[]},        
        #                  }
        
    image_lists = create_image_lists(TEST_PERCENTAGE, VALIDATION_PERCENTAGE)
    # n_classes: 花的类别数量
    n_classes = len(image_lists.keys())
    
    # 读取已经训练好的Inception-v3模型。
    # gfile.FastGFile 读取文件原始数据，参数是训练好的pb模型文件路径；
    # graph_def 和 f.read() 联系起来，graph_def保存了取得的 pb 模型文件
    # 通过 import_graph_def 取得模型输出张量和输入图片张量
    # BOTTLENECK_TENSOR_NAME 输出张量名字， bottleneck_tensor输出张量
    # JPEG_DATA_TENSOR_NAME 图像输入张量名字， jpeg_data_tensor 图像输入张量
    with gfile.FastGFile(os.path.join(MODEL_DIR, MODEL_FILE), 'rb') as f:
        graph_def = tf.GraphDef()
        graph_def.ParseFromString(f.read())
    bottleneck_tensor, jpeg_data_tensor = tf.import_graph_def(
        graph_def, return_elements=[BOTTLENECK_TENSOR_NAME, JPEG_DATA_TENSOR_NAME])


    # 定义新的神经网络输入：全链接层的输入和输出
    bottleneck_input = tf.placeholder(tf.float32, [None, BOTTLENECK_TENSOR_SIZE], name='BottleneckInputPlaceholder')
    ground_truth_input = tf.placeholder(tf.float32, [None, n_classes], name='GroundTruthInput')
    
    # 定义一层全链接层
    with tf.name_scope('final_training_ops'):
        weights = tf.Variable(tf.truncated_normal([BOTTLENECK_TENSOR_SIZE, n_classes], stddev=0.001))
        biases = tf.Variable(tf.zeros([n_classes]))
        logits = tf.matmul(bottleneck_input, weights) + biases
        final_tensor = tf.nn.softmax(logits)
        
    # 定义交叉熵损失函数。
    cross_entropy = tf.nn.softmax_cross_entropy_with_logits(logits=logits, labels=ground_truth_input)
    cross_entropy_mean = tf.reduce_mean(cross_entropy)
    # train_step -- 训练集上的求解
    train_step = tf.train.GradientDescentOptimizer(LEARNING_RATE).minimize(cross_entropy_mean)
    
    # 计算正确率。
    with tf.name_scope('evaluation'):
        # argmax: 0代表按照列选取，1代表按照行选取
        # ground_truth_input的大小是100，即[[],[],[],[],...100个[]]
        correct_prediction = tf.equal(tf.argmax(final_tensor, 1), tf.argmax(ground_truth_input, 1))
        evaluation_step = tf.reduce_mean(tf.cast(correct_prediction, tf.float32))


    with tf.Session() as sess:
        init = tf.global_variables_initializer()
        sess.run(init)
        # 训练过程。
        for i in range(STEPS):
            # 训练过程：training process
            # train_bottlenecks 图片的特征向量列表，也就是对应模型全链接层的输入向量
            # train_ground_truth 和图片特征向量对应的图片类别列表，对应模型全链接层的输出向量
            # 这个相对于形成一个标注的训练数据，而且是特征向量和类别的直接对应
            train_bottlenecks, train_ground_truth = get_random_cached_bottlenecks(
                sess, n_classes, image_lists, BATCH, 'training', jpeg_data_tensor, bottleneck_tensor)
            sess.run(train_step, feed_dict={bottleneck_input: train_bottlenecks, ground_truth_input: train_ground_truth})
            
            # 验证过程： validation process
            # 满 100，或者最有一次运行后，用验证数据集计算模型的准确率,验证数据集的大小也是100
            if i % 100 == 0 or i + 1 == STEPS:
                validation_bottlenecks, validation_ground_truth = get_random_cached_bottlenecks(
                    sess, n_classes, image_lists, BATCH, 'validation', jpeg_data_tensor, bottleneck_tensor)
                validation_accuracy = sess.run(evaluation_step, feed_dict={
                    bottleneck_input: validation_bottlenecks, ground_truth_input: validation_ground_truth})
                print('Step %d: Validation accuracy on random sampled %d examples = %.1f%%' %
                    (i, BATCH, validation_accuracy * 100))
            
        # 测试过程    
        # 在最后的测试数据上测试正确率。
        test_bottlenecks, test_ground_truth = get_test_bottlenecks(
            sess, image_lists, n_classes, jpeg_data_tensor, bottleneck_tensor)
        test_accuracy = sess.run(evaluation_step, feed_dict={
            bottleneck_input: test_bottlenecks, ground_truth_input: test_ground_truth})
        print('Final test accuracy = %.1f%%' % (test_accuracy * 100))


if __name__ == '__main__':
    main()