#ifndef CAFFE_BLOB_HPP_
#define CAFFE_BLOB_HPP_
#include <algorithm>
#include <string>
#include <vector>
#include "caffe/common.hpp" //单例化caffe类,封装了boost和cuda随机数生成的函数,提供了统一接口
#include "caffe/proto/caffe.pb.h"
#include "caffe/syncedmem.hpp" //主要:分配内存和释放内存的。Class SyncedMemory定义内存分配管理和Cpu与GPU中间同步的函数。
#include "caffe/util/math_functions.hpp" //封装了很多cblas矩阵运算,基本是矩阵和向量的处理函数
const int kMaxBlobAxes = INT_MAX;
namespace caffe {
/**
* @brief A wrapper around SyncedMemory holders serving as the basic
* computational unit through which Layer%s, Net%s, and Solver%s
* interact.
*
* TODO(dox): more thorough description.
*/
template <typename Dtype>
class Blob {
public:
Blob()
: data_(), diff_(), count_(0), capacity_(0) {}
//Blob作为一个最基础的类,构造函数:开辟一个存储空间来存储数据。
//data和diff两类数据。
//data:存储前向传递的数据,表示流动数据(输出数据);
//diff:偏差,存储后向传播(BP)中的梯度
//num:输入数量。eg:sgd时,mini-batch大小
//channels:通道数量
//对于卷积权重:output*input*height*width
//对于卷积偏置:output*1*1*1
//对于卷积层输出:输入图片数量*对应feature maps数量*输出图片的高度*输出图片的宽度
/// @brief Deprecated; use <code>Blob(const vector<int>& shape)</code>.
explicit Blob(const int num, const int channels, const int height,
const int width);
explicit Blob(const vector<int>& shape);
/// @brief Deprecated; use <code>Reshape(const vector<int>& shape)</code>.
void Reshape(const int num, const int channels, const int height,
const int width); //reshape函数在Layer中的reshape或者forward操作中来调整维度(adjust dimension)
//同时在改变Blob大小时,内存将会被重新分配,如果内存大小不够,额外的内存将不会被释放。
//对input的blob进行reshape,如果立马调用Net::Backward会出错,因为reshape后,那么Net::forward或者Net::Reshape就会被调用来将新的input shape传播到高层。
/**
* @brief Change the dimensions of the blob, allocating new memory if
* necessary.
*
* This function can be called both to create an initial allocation
* of memory, and to adjust the dimensions of a top blob during Layer::Reshape
* or Layer::Forward. When changing the size of blob, memory will only be
* reallocated if sufficient memory does not already exist, and excess memory
* will never be freed.
*
* Note that reshaping an input blob and immediately calling Net::Backward is
* an error; either Net::Forward or Net::Reshape need to be called to
* propagate the new input shape to higher layers.
*/
void Reshape(const vector<int>& shape);
void Reshape(const BlobShape& shape);
void ReshapeLike(const Blob& other);
inline string shape_string() const {
ostringstream stream;
for (int i = 0; i < shape_.size(); ++i) {
stream << shape_[i] << " ";
}
stream << "(" << count_ << ")";
return stream.str();
}
inline const vector<int>& shape() const { return shape_; }
/**
* @brief Returns the dimension of the index-th axis (or the negative index-th
* axis from the end, if index is negative).
*
* @param index the axis index, which may be negative as it will be
* "canonicalized" using CanonicalAxisIndex.
* Dies on out of range index.
*/
inline int shape(int index) const {
return shape_[CanonicalAxisIndex(index)];
}
inline int num_axes() const { return shape_.size(); } //返回的是blob的大小
inline int count() const { return count_; }
/**
* @brief Compute the volume of a slice; i.e., the product of dimensions
* among a range of axes.
*
* @param start_axis The first axis to include in the slice.
*
* @param end_axis The first axis to exclude from the slice.
*/
inline int count(int start_axis, int end_axis) const {
//Blob类里面有重载很多歌count()函数,主要为了统计Blob的容量(volume)/一片(slice)。从某个axis到具体某个axis的shape乘积。
//计算得到count
CHECK_LE(start_axis, end_axis);
CHECK_GE(start_axis, 0);
CHECK_GE(end_axis, 0);
CHECK_LE(start_axis, num_axes());
CHECK_LE(end_axis, num_axes());
int count = 1;
for (int i = start_axis; i < end_axis; ++i) {
count *= shape(i);
}
return count;
}
/**
* @brief Compute the volume of a slice spanning from a particular first
* axis to the final axis.
*
* @param start_axis The first axis to include in the slice.
*/
inline int count(int start_axis) const {
return count(start_axis, num_axes());
}
/**
* @brief Returns the 'canonical' version of a (usually) user-specified axis,
* allowing for negative indexing (e.g., -1 for the last axis).
*
* @param index the axis index.
* If 0 <= index < num_axes(), return index.
* If -num_axes <= index <= -1, return (num_axes() - (-index)),
* e.g., the last axis index (num_axes() - 1) if index == -1,
* the second to last if index == -2, etc.
* Dies on out of range index.
*/
inline int CanonicalAxisIndex(int axis_index) const {
//Blob的Index是可以从负坐标开始读的,这一点跟Python很像
CHECK_GE(axis_index, -num_axes())
<< "axis " << axis_index << " out of range for " << num_axes()
<< "-D Blob with shape " << shape_string();
CHECK_LT(axis_index, num_axes())
<< "axis " << axis_index << " out of range for " << num_axes()
<< "-D Blob with shape " << shape_string();
if (axis_index < 0) {
return axis_index + num_axes();
}
return axis_index;
}
//Blob中的4个基本变量num,channel,height,width可以直接通过shape(0)、shape(1)、shape(2)、shape(3)来访问
/// @brief Deprecated legacy shape accessor num: use shape(0) instead.
inline int num() const { return LegacyShape(0); }
/// @brief Deprecated legacy shape accessor channels: use shape(1) instead.
inline int channels() const { return LegacyShape(1); }
/// @brief Deprecated legacy shape accessor height: use shape(2) instead.
inline int height() const { return LegacyShape(2); }
/// @brief Deprecated legacy shape accessor width: use shape(3) instead.
inline int width() const { return LegacyShape(3); }
inline int LegacyShape(int index) const {
CHECK_LE(num_axes(), 4)
<< "Cannot use legacy accessors on Blobs with > 4 axes.";
CHECK_LT(index, 4);
CHECK_GE(index, -4);
if (index >= num_axes() || index < -num_axes()) {
// Axis is out of range, but still in [0, 3] (or [-4, -1] for reverse
// indexing) -- this special case simulates the one-padding used to fill
// extraneous axes of legacy blobs.
return 1;
}
return shape(index);
}
//计算offset。计算的方式支持两种方式:一种直接指定n,c,h,w。一种放到一个vector中进行计算。
//偏差是根据对应的n,c,h,w,返回的offset是((n * channels() + c) * height() + h) * width() + w
inline int offset(const int n, const int c = 0, const int h = 0,
const int w = 0) const { //计算输入blob数据(n,c,h,w)的偏移量位置
CHECK_GE(n, 0);
CHECK_LE(n, num());
CHECK_GE(channels(), 0);
CHECK_LE(c, channels());
CHECK_GE(height(), 0);
CHECK_LE(h, height());
CHECK_GE(width(), 0);
CHECK_LE(w, width());
return ((n * channels() + c) * height() + h) * width() + w;
}
inline int offset(const vector<int>& indices) const {
CHECK_LE(indices.size(), num_axes());
int offset = 0;
for (int i = 0; i < num_axes(); ++i) {
offset *= shape(i);
if (indices.size() > i) {
CHECK_GE(indices[i], 0);
CHECK_LT(indices[i], shape(i));
offset += indices[i];
}
}
return offset;
}
/**
* @brief Copy from a source Blob.
*
* @param source the Blob to copy from
* @param copy_diff if false, copy the data; if true, copy the diff
* @param reshape if false, require this Blob to be pre-shaped to the shape
* of other (and die otherwise); if true, Reshape this Blob to other's
* shape if necessary
*/
void CopyFrom(const Blob<Dtype>& source, bool copy_diff = false,
bool reshape = false);
//从source拷贝数据,copy_diff来作为标志区分是拷贝data还是diff
//从一个blob中复制数据,通过开关控制是否copy_diff,如果是false则copy data;reshape控制是否reshape。
//下面部分的函数:主要通过给定的位置访问数据,根据位置计算与数据起始的偏差offset,再通过cpu_data*指针获得地址。
inline Dtype data_at(const int n, const int c, const int h,
const int w) const {
return cpu_data()[offset(n, c, h, w)];
}
inline Dtype diff_at(const int n, const int c, const int h,
const int w) const {
return cpu_diff()[offset(n, c, h, w)];
}
inline Dtype data_at(const vector<int>& index) const {
return cpu_data()[offset(index)];
}
inline Dtype diff_at(const vector<int>& index) const {
return cpu_diff()[offset(index)];
}
inline const shared_ptr<SyncedMemory>& data() const {
CHECK(data_);
return data_;
}
inline const shared_ptr<SyncedMemory>& diff() const {
CHECK(diff_);
return diff_;
}
const Dtype* cpu_data() const;
void set_cpu_data(Dtype* data);
const Dtype* gpu_data() const;
const Dtype* cpu_diff() const;
const Dtype* gpu_diff() const;
Dtype* mutable_cpu_data();
Dtype* mutable_gpu_data();
Dtype* mutable_cpu_diff();
Dtype* mutable_gpu_diff();
void Update(); //调用caffe/utils/math_funtions.cpp下的update函数。也就是blob里面的data部分减去diff部分。
//下面这两个函数主要将数据序列化,存储到BlobProto,这里说到Proto是酷哥的一个数据序列化的存储格式,可以实现语言平台无关,可扩展的序列化结构数据格式。
//Caffe里面的数据的存储都采用这一结构。
void FromProto(const BlobProto& proto, bool reshape = true); //从proto读数据进来,其实就是反序列化。
void ToProto(BlobProto* proto, bool write_diff = false) const; //把blob数据保存到proto
/// @brief Compute the sum of absolute values (L1 norm) of the data.
Dtype asum_data() const; //计算data的L1范数
/// @brief Compute the sum of absolute values (L1 norm) of the diff.
Dtype asum_diff() const; //计算diff的L1范数
/// @brief Compute the sum of squares (L2 norm squared) of the data.
Dtype sumsq_data() const; //计算data的L2范数
/// @brief Compute the sum of squares (L2 norm squared) of the diff.
Dtype sumsq_diff() const; //计算diff的L2范数
/// @brief Scale the blob data by a constant factor.
void scale_data(Dtype scale_factor); //将data部分乘以一个因子
/// @brief Scale the blob diff by a constant factor.
void scale_diff(Dtype scale_factor); //将diff部分乘以一个因子
/**
* @brief Set the data_ shared_ptr to point to the SyncedMemory holding the
* data_ of Blob other -- useful in Layer%s which simply perform a copy
* in their Forward pass.
*
* This deallocates the SyncedMemory holding this Blob's data_, as
* shared_ptr calls its destructor when reset with the "=" operator.
*/
void ShareData(const Blob& other); //从other的blob复制data和diff的值
//共享data。具体:将别的blob的data和相应的diff指针给这个Blob,实现数据的共享。
//同时注意:这个操作会引起这个Blob里面的SyncedMemory被释放,因为shared_ptr指针被重置的时候回调响应的析构器。
/**
* @brief Set the diff_ shared_ptr to point to the SyncedMemory holding the
* diff_ of Blob other -- useful in Layer%s which simply perform a copy
* in their Forward pass.
*
* This deallocates the SyncedMemory holding this Blob's diff_, as
* shared_ptr calls its destructor when reset with the "=" operator.
*/
void ShareDiff(const Blob& other); //共享diff
bool ShapeEquals(const BlobProto& other); //比较两个Blob形状是否相同。
protected:
shared_ptr<SyncedMemory> data_; //data指针,指针类型是shared_ptr,属于boost智能指针,申请内存存储data,data主要是正向传播的时候用
shared_ptr<SyncedMemory> diff_; //存储偏差,update data
vector<int> shape_; //存储Blob的形状
int count_; //Blob中的元素个数:个数*通道数*高度*宽度
int capacity_; //当前元素的个数,因为Blob可能会reshape
DISABLE_COPY_AND_ASSIGN(Blob);
}; // class Blob
} // namespace caffe
#endif // CAFFE_BLOB_HPP_
#define CAFFE_BLOB_HPP_
#include <algorithm>
#include <string>
#include <vector>
#include "caffe/common.hpp" //单例化caffe类,封装了boost和cuda随机数生成的函数,提供了统一接口
#include "caffe/proto/caffe.pb.h"
#include "caffe/syncedmem.hpp" //主要:分配内存和释放内存的。Class SyncedMemory定义内存分配管理和Cpu与GPU中间同步的函数。
#include "caffe/util/math_functions.hpp" //封装了很多cblas矩阵运算,基本是矩阵和向量的处理函数
const int kMaxBlobAxes = INT_MAX;
namespace caffe {
/**
* @brief A wrapper around SyncedMemory holders serving as the basic
* computational unit through which Layer%s, Net%s, and Solver%s
* interact.
*
* TODO(dox): more thorough description.
*/
template <typename Dtype>
class Blob {
public:
Blob()
: data_(), diff_(), count_(0), capacity_(0) {}
//Blob作为一个最基础的类,构造函数:开辟一个存储空间来存储数据。
//data和diff两类数据。
//data:存储前向传递的数据,表示流动数据(输出数据);
//diff:偏差,存储后向传播(BP)中的梯度
//num:输入数量。eg:sgd时,mini-batch大小
//channels:通道数量
//对于卷积权重:output*input*height*width
//对于卷积偏置:output*1*1*1
//对于卷积层输出:输入图片数量*对应feature maps数量*输出图片的高度*输出图片的宽度
/// @brief Deprecated; use <code>Blob(const vector<int>& shape)</code>.
explicit Blob(const int num, const int channels, const int height,
const int width);
explicit Blob(const vector<int>& shape);
/// @brief Deprecated; use <code>Reshape(const vector<int>& shape)</code>.
void Reshape(const int num, const int channels, const int height,
const int width); //reshape函数在Layer中的reshape或者forward操作中来调整维度(adjust dimension)
//同时在改变Blob大小时,内存将会被重新分配,如果内存大小不够,额外的内存将不会被释放。
//对input的blob进行reshape,如果立马调用Net::Backward会出错,因为reshape后,那么Net::forward或者Net::Reshape就会被调用来将新的input shape传播到高层。
/**
* @brief Change the dimensions of the blob, allocating new memory if
* necessary.
*
* This function can be called both to create an initial allocation
* of memory, and to adjust the dimensions of a top blob during Layer::Reshape
* or Layer::Forward. When changing the size of blob, memory will only be
* reallocated if sufficient memory does not already exist, and excess memory
* will never be freed.
*
* Note that reshaping an input blob and immediately calling Net::Backward is
* an error; either Net::Forward or Net::Reshape need to be called to
* propagate the new input shape to higher layers.
*/
void Reshape(const vector<int>& shape);
void Reshape(const BlobShape& shape);
void ReshapeLike(const Blob& other);
inline string shape_string() const {
ostringstream stream;
for (int i = 0; i < shape_.size(); ++i) {
stream << shape_[i] << " ";
}
stream << "(" << count_ << ")";
return stream.str();
}
inline const vector<int>& shape() const { return shape_; }
/**
* @brief Returns the dimension of the index-th axis (or the negative index-th
* axis from the end, if index is negative).
*
* @param index the axis index, which may be negative as it will be
* "canonicalized" using CanonicalAxisIndex.
* Dies on out of range index.
*/
inline int shape(int index) const {
return shape_[CanonicalAxisIndex(index)];
}
inline int num_axes() const { return shape_.size(); } //返回的是blob的大小
inline int count() const { return count_; }
/**
* @brief Compute the volume of a slice; i.e., the product of dimensions
* among a range of axes.
*
* @param start_axis The first axis to include in the slice.
*
* @param end_axis The first axis to exclude from the slice.
*/
inline int count(int start_axis, int end_axis) const {
//Blob类里面有重载很多歌count()函数,主要为了统计Blob的容量(volume)/一片(slice)。从某个axis到具体某个axis的shape乘积。
//计算得到count
CHECK_LE(start_axis, end_axis);
CHECK_GE(start_axis, 0);
CHECK_GE(end_axis, 0);
CHECK_LE(start_axis, num_axes());
CHECK_LE(end_axis, num_axes());
int count = 1;
for (int i = start_axis; i < end_axis; ++i) {
count *= shape(i);
}
return count;
}
/**
* @brief Compute the volume of a slice spanning from a particular first
* axis to the final axis.
*
* @param start_axis The first axis to include in the slice.
*/
inline int count(int start_axis) const {
return count(start_axis, num_axes());
}
/**
* @brief Returns the 'canonical' version of a (usually) user-specified axis,
* allowing for negative indexing (e.g., -1 for the last axis).
*
* @param index the axis index.
* If 0 <= index < num_axes(), return index.
* If -num_axes <= index <= -1, return (num_axes() - (-index)),
* e.g., the last axis index (num_axes() - 1) if index == -1,
* the second to last if index == -2, etc.
* Dies on out of range index.
*/
inline int CanonicalAxisIndex(int axis_index) const {
//Blob的Index是可以从负坐标开始读的,这一点跟Python很像
CHECK_GE(axis_index, -num_axes())
<< "axis " << axis_index << " out of range for " << num_axes()
<< "-D Blob with shape " << shape_string();
CHECK_LT(axis_index, num_axes())
<< "axis " << axis_index << " out of range for " << num_axes()
<< "-D Blob with shape " << shape_string();
if (axis_index < 0) {
return axis_index + num_axes();
}
return axis_index;
}
//Blob中的4个基本变量num,channel,height,width可以直接通过shape(0)、shape(1)、shape(2)、shape(3)来访问
/// @brief Deprecated legacy shape accessor num: use shape(0) instead.
inline int num() const { return LegacyShape(0); }
/// @brief Deprecated legacy shape accessor channels: use shape(1) instead.
inline int channels() const { return LegacyShape(1); }
/// @brief Deprecated legacy shape accessor height: use shape(2) instead.
inline int height() const { return LegacyShape(2); }
/// @brief Deprecated legacy shape accessor width: use shape(3) instead.
inline int width() const { return LegacyShape(3); }
inline int LegacyShape(int index) const {
CHECK_LE(num_axes(), 4)
<< "Cannot use legacy accessors on Blobs with > 4 axes.";
CHECK_LT(index, 4);
CHECK_GE(index, -4);
if (index >= num_axes() || index < -num_axes()) {
// Axis is out of range, but still in [0, 3] (or [-4, -1] for reverse
// indexing) -- this special case simulates the one-padding used to fill
// extraneous axes of legacy blobs.
return 1;
}
return shape(index);
}
//计算offset。计算的方式支持两种方式:一种直接指定n,c,h,w。一种放到一个vector中进行计算。
//偏差是根据对应的n,c,h,w,返回的offset是((n * channels() + c) * height() + h) * width() + w
inline int offset(const int n, const int c = 0, const int h = 0,
const int w = 0) const { //计算输入blob数据(n,c,h,w)的偏移量位置
CHECK_GE(n, 0);
CHECK_LE(n, num());
CHECK_GE(channels(), 0);
CHECK_LE(c, channels());
CHECK_GE(height(), 0);
CHECK_LE(h, height());
CHECK_GE(width(), 0);
CHECK_LE(w, width());
return ((n * channels() + c) * height() + h) * width() + w;
}
inline int offset(const vector<int>& indices) const {
CHECK_LE(indices.size(), num_axes());
int offset = 0;
for (int i = 0; i < num_axes(); ++i) {
offset *= shape(i);
if (indices.size() > i) {
CHECK_GE(indices[i], 0);
CHECK_LT(indices[i], shape(i));
offset += indices[i];
}
}
return offset;
}
/**
* @brief Copy from a source Blob.
*
* @param source the Blob to copy from
* @param copy_diff if false, copy the data; if true, copy the diff
* @param reshape if false, require this Blob to be pre-shaped to the shape
* of other (and die otherwise); if true, Reshape this Blob to other's
* shape if necessary
*/
void CopyFrom(const Blob<Dtype>& source, bool copy_diff = false,
bool reshape = false);
//从source拷贝数据,copy_diff来作为标志区分是拷贝data还是diff
//从一个blob中复制数据,通过开关控制是否copy_diff,如果是false则copy data;reshape控制是否reshape。
//下面部分的函数:主要通过给定的位置访问数据,根据位置计算与数据起始的偏差offset,再通过cpu_data*指针获得地址。
inline Dtype data_at(const int n, const int c, const int h,
const int w) const {
return cpu_data()[offset(n, c, h, w)];
}
inline Dtype diff_at(const int n, const int c, const int h,
const int w) const {
return cpu_diff()[offset(n, c, h, w)];
}
inline Dtype data_at(const vector<int>& index) const {
return cpu_data()[offset(index)];
}
inline Dtype diff_at(const vector<int>& index) const {
return cpu_diff()[offset(index)];
}
inline const shared_ptr<SyncedMemory>& data() const {
CHECK(data_);
return data_;
}
inline const shared_ptr<SyncedMemory>& diff() const {
CHECK(diff_);
return diff_;
}
const Dtype* cpu_data() const;
void set_cpu_data(Dtype* data);
const Dtype* gpu_data() const;
const Dtype* cpu_diff() const;
const Dtype* gpu_diff() const;
Dtype* mutable_cpu_data();
Dtype* mutable_gpu_data();
Dtype* mutable_cpu_diff();
Dtype* mutable_gpu_diff();
void Update(); //调用caffe/utils/math_funtions.cpp下的update函数。也就是blob里面的data部分减去diff部分。
//下面这两个函数主要将数据序列化,存储到BlobProto,这里说到Proto是酷哥的一个数据序列化的存储格式,可以实现语言平台无关,可扩展的序列化结构数据格式。
//Caffe里面的数据的存储都采用这一结构。
void FromProto(const BlobProto& proto, bool reshape = true); //从proto读数据进来,其实就是反序列化。
void ToProto(BlobProto* proto, bool write_diff = false) const; //把blob数据保存到proto
/// @brief Compute the sum of absolute values (L1 norm) of the data.
Dtype asum_data() const; //计算data的L1范数
/// @brief Compute the sum of absolute values (L1 norm) of the diff.
Dtype asum_diff() const; //计算diff的L1范数
/// @brief Compute the sum of squares (L2 norm squared) of the data.
Dtype sumsq_data() const; //计算data的L2范数
/// @brief Compute the sum of squares (L2 norm squared) of the diff.
Dtype sumsq_diff() const; //计算diff的L2范数
/// @brief Scale the blob data by a constant factor.
void scale_data(Dtype scale_factor); //将data部分乘以一个因子
/// @brief Scale the blob diff by a constant factor.
void scale_diff(Dtype scale_factor); //将diff部分乘以一个因子
/**
* @brief Set the data_ shared_ptr to point to the SyncedMemory holding the
* data_ of Blob other -- useful in Layer%s which simply perform a copy
* in their Forward pass.
*
* This deallocates the SyncedMemory holding this Blob's data_, as
* shared_ptr calls its destructor when reset with the "=" operator.
*/
void ShareData(const Blob& other); //从other的blob复制data和diff的值
//共享data。具体:将别的blob的data和相应的diff指针给这个Blob,实现数据的共享。
//同时注意:这个操作会引起这个Blob里面的SyncedMemory被释放,因为shared_ptr指针被重置的时候回调响应的析构器。
/**
* @brief Set the diff_ shared_ptr to point to the SyncedMemory holding the
* diff_ of Blob other -- useful in Layer%s which simply perform a copy
* in their Forward pass.
*
* This deallocates the SyncedMemory holding this Blob's diff_, as
* shared_ptr calls its destructor when reset with the "=" operator.
*/
void ShareDiff(const Blob& other); //共享diff
bool ShapeEquals(const BlobProto& other); //比较两个Blob形状是否相同。
protected:
shared_ptr<SyncedMemory> data_; //data指针,指针类型是shared_ptr,属于boost智能指针,申请内存存储data,data主要是正向传播的时候用
shared_ptr<SyncedMemory> diff_; //存储偏差,update data
vector<int> shape_; //存储Blob的形状
int count_; //Blob中的元素个数:个数*通道数*高度*宽度
int capacity_; //当前元素的个数,因为Blob可能会reshape
DISABLE_COPY_AND_ASSIGN(Blob);
}; // class Blob
} // namespace caffe
#endif // CAFFE_BLOB_HPP_