Minor improvements in docstrings and crates.io tags

Author: Mottl

Cargo.toml

@@ -8,7 +8,7 @@ repository = "https://github.com/Mottl/lightgbm3-rs"
 description = "Rust bindings for LightGBM library"
 documentation = "https://docs.rs/lightgbm3/"
 keywords = ["lightgbm", "machine-learning", "gradient-boosting"]
-categories = ["api-bindings"]
+categories = ["api-bindings", "science"]
 readme = "README.md"
 exclude = [".gitignore", ".github", ".gitmodules", "examples", "benches", "lightgbm3-sys"]
 

README.md

@@ -62,7 +62,7 @@ bst.save_file("path/to/model.lgb").unwrap();
 use lightgbm3::{Dataset, Booster};
 
 let bst = Booster::from_file("path/to/model.lgb").unwrap();
-let features = vec![1.0, 2.0, 33.0, -5.0];
+let features = vec![1.0, 2.0, -5.0];
 let n_features = features.len();
 let y_pred = bst.predict(&features, n_features as i32, true).unwrap()[0];
 ```

lightgbm3-sys/Cargo.toml

@@ -7,6 +7,7 @@ build = "build.rs"
 license = "MIT"
 repository = "https://github.com/Mottl/lightgbm3-rs"
 description = "Low-level Rust bindings for LightGBM library"
+categories = ["external-ffi-bindings"]
 readme = "README.md"
 exclude = ["README.md", ".gitlab-ci.yml", ".hgeol", ".gitignore", ".appveyor.yml", ".coveralls.yml", ".travis.yml", ".github", ".gitmodules", ".nuget", "**/*.md", "lightgbm/compute/doc", "lightgbm/compute/example", "lightgbm/compute/index.html", "lightgbm/compute/perf", "lightgbm/compute/test", "lightgbm/eigen/debug", "lightgbm/eigen/demos", "lightgbm/eigen/doc", "lightgbm/eigen/failtest", "lightgbm/eigen/test", "lightgbm/examples", "lightgbm/external_libs/fast_double_parser/benchmarks", "lightgbm/external_libs/fmt/doc", "lightgbm/external_libs/fmt/test"]
 

src/booster.rs

@@ -16,8 +16,9 @@ pub struct Booster {
     n_classes: i32,
 }
 
-// Prediction type
-// <https://lightgbm.readthedocs.io/en/latest/C-API.html#c.LGBM_BoosterPredictForMat>
+/// Prediction type
+///
+/// <https://lightgbm.readthedocs.io/en/latest/C-API.html#c.LGBM_BoosterPredictForMat>
 enum PredictType {
     Normal,
     RawScore,
@@ -143,7 +144,7 @@ impl Booster {
         self.n_features
     }
 
-    /// Get the number of iterations.
+    /// Get the number of iterations in the booster.
     pub fn num_iterations(&self) -> i32 {
         self.n_iterations
     }
@@ -153,7 +154,7 @@ impl Booster {
         self.max_iterations
     }
 
-    /// Sets the the maximum number of iterations for prediction
+    /// Sets the the maximum number of iterations for prediction.
     pub fn set_max_iterations(&mut self, max_iterations: i32) -> Result<()> {
         if max_iterations > self.n_iterations {
             return Err(Error::new(format!(

src/lib.rs

@@ -35,7 +35,7 @@
 //! use lightgbm3::{Dataset, Booster};
 //!
 //! let bst = Booster::from_file("path/to/model.lgb").unwrap();
-//! let features = vec![1.0, 2.0, 33.0, -5.0];
+//! let features = vec![1.0, 2.0, -5.0];
 //! let n_features = features.len();
 //! let y_pred = bst.predict(&features, n_features as i32, true).unwrap()[0];
 //! ```
@@ -54,7 +54,7 @@ pub use booster::{Booster, ImportanceType};
 pub use dataset::Dataset;
 pub use error::{Error, Result};
 
-/// Get the index of the element in a slice with the maximum value
+/// Get index of the element in a slice with the maximum value
 pub fn argmax<T: PartialOrd>(xs: &[T]) -> usize {
     if xs.len() == 1 {
         0