Commit d7f8aa53 authored by James Lamb's avatar James Lamb Committed by Nikita Titov
Browse files

[docs] fixed miscellaneous typos in comments and documentation (#2496)

* fixed miscellaneous typos in documentation

* fix typo introduced in typo-fixing PR
parent ff4e48ce
...@@ -56,7 +56,7 @@ class TreeLearner { ...@@ -56,7 +56,7 @@ class TreeLearner {
const Json& forced_split_json) = 0; const Json& forced_split_json) = 0;
/*! /*!
* \brief use a existing tree to fit the new gradients and hessians. * \brief use an existing tree to fit the new gradients and hessians.
*/ */
virtual Tree* FitByExistingTree(const Tree* old_tree, const score_t* gradients, const score_t* hessians) const = 0; virtual Tree* FitByExistingTree(const Tree* old_tree, const score_t* gradients, const score_t* hessians) const = 0;
......
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
namespace LightGBM { namespace LightGBM {
/*! /*!
* \brief Contains some operation for a array, e.g. ArgMax, TopK. * \brief Contains some operation for an array, e.g. ArgMax, TopK.
*/ */
template<typename VAL_T> template<typename VAL_T>
class ArrayArgs { class ArrayArgs {
......
...@@ -595,7 +595,7 @@ inline static int64_t Pow2RoundUp(int64_t x) { ...@@ -595,7 +595,7 @@ inline static int64_t Pow2RoundUp(int64_t x) {
} }
/*! /*!
* \brief Do inplace softmax transformaton on p_rec * \brief Do inplace softmax transformation on p_rec
* \param p_rec The input/output vector of the values. * \param p_rec The input/output vector of the values.
*/ */
inline static void Softmax(std::vector<double>* p_rec) { inline static void Softmax(std::vector<double>* p_rec) {
......
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
namespace LightGBM { namespace LightGBM {
/*! /*!
* \brief An network basic communication warpper. * \brief A network basic communication warpper.
* Will warp low level communication methods, e.g. mpi, socket and so on. * Will warp low level communication methods, e.g. mpi, socket and so on.
* This class will wrap all linkers to other machines if needs * This class will wrap all linkers to other machines if needs
*/ */
...@@ -52,7 +52,7 @@ class Linkers { ...@@ -52,7 +52,7 @@ class Linkers {
* \brief Recv data, blocking * \brief Recv data, blocking
* \param rank Which rank will send data to local machine * \param rank Which rank will send data to local machine
* \param data Pointer of receive data * \param data Pointer of receive data
* \prama len Recv size, will block until recive len size of data * \param len Recv size, will block until recive len size of data
*/ */
inline void Recv(int rank, char* data, int len) const; inline void Recv(int rank, char* data, int len) const;
...@@ -62,7 +62,7 @@ class Linkers { ...@@ -62,7 +62,7 @@ class Linkers {
* \brief Send data, blocking * \brief Send data, blocking
* \param rank Which rank local machine will send to * \param rank Which rank local machine will send to
* \param data Pointer of send data * \param data Pointer of send data
* \prama len Send size * \param len Send size
*/ */
inline void Send(int rank, char* data, int len) const; inline void Send(int rank, char* data, int len) const;
...@@ -71,10 +71,10 @@ class Linkers { ...@@ -71,10 +71,10 @@ class Linkers {
* \brief Send and Recv at same time, blocking * \brief Send and Recv at same time, blocking
* \param send_rank * \param send_rank
* \param send_data * \param send_data
* \prama send_len * \param send_len
* \param recv_rank * \param recv_rank
* \param recv_data * \param recv_data
* \prama recv_len * \param recv_len
*/ */
inline void SendRecv(int send_rank, char* send_data, int send_len, inline void SendRecv(int send_rank, char* send_data, int send_len,
int recv_rank, char* recv_data, int recv_len); int recv_rank, char* recv_data, int recv_len);
......
...@@ -189,13 +189,13 @@ class GPUTreeLearner: public SerialTreeLearner { ...@@ -189,13 +189,13 @@ class GPUTreeLearner: public SerialTreeLearner {
/*! \brief Currently used kernel name */ /*! \brief Currently used kernel name */
std::string kernel_name_; std::string kernel_name_;
/*! \brief a array of histogram kernels with different number /*! \brief an array of histogram kernels with different number
of workgroups per feature */ of workgroups per feature */
std::vector<boost::compute::kernel> histogram_kernels_; std::vector<boost::compute::kernel> histogram_kernels_;
/*! \brief a array of histogram kernels with different number /*! \brief an array of histogram kernels with different number
of workgroups per feature, with all features enabled to avoid branches */ of workgroups per feature, with all features enabled to avoid branches */
std::vector<boost::compute::kernel> histogram_allfeats_kernels_; std::vector<boost::compute::kernel> histogram_allfeats_kernels_;
/*! \brief a array of histogram kernels with different number /*! \brief an array of histogram kernels with different number
of workgroups per feature, and processing the whole dataset */ of workgroups per feature, and processing the whole dataset */
std::vector<boost::compute::kernel> histogram_fulldata_kernels_; std::vector<boost::compute::kernel> histogram_fulldata_kernels_;
/*! \brief total number of feature-groups */ /*! \brief total number of feature-groups */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment