From bccbdd4d9c1cb50323540ae37168008c12e0174e Mon Sep 17 00:00:00 2001 From: Andrew Kane Date: Sun, 30 Jun 2024 22:49:08 -0700 Subject: [PATCH] Updated docs [skip ci] --- README.md | 8 ++++---- src/params.rs | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3322984..91c6be6 100644 --- a/README.md +++ b/README.md @@ -90,10 +90,10 @@ libmf::Model::params() .threads(12) // number of threads .bins(25) // number of bins .iterations(20) // number of iterations - .lambda_p1(0.0) // coefficient of L1-norm regularization for P - .lambda_p2(0.1) // coefficient of L2-norm regularization for P - .lambda_q1(0.0) // coefficient of L1-norm regularization for Q - .lambda_q2(0.1) // coefficient of L2-norm regularization for Q + .lambda_p1(0.0) // L1-regularization parameter for P + .lambda_p2(0.1) // L2-regularization parameter for P + .lambda_q1(0.0) // L1-regularization parameter for Q + .lambda_q2(0.1) // L2-regularization parameter for Q .learning_rate(0.1) // learning rate .alpha(1.0) // importance of negative entries .c(0.0001) // desired value of negative entries diff --git a/src/params.rs b/src/params.rs index 60128e2..ecb668d 100644 --- a/src/params.rs +++ b/src/params.rs @@ -43,25 +43,25 @@ impl Params { self } - /// Sets the coefficient of L1-norm regularization for P. + /// Sets the L1-regularization parameter for P. pub fn lambda_p1(&mut self, value: f32) -> &mut Self { self.param.lambda_p1 = value; self } - /// Sets the coefficient of L2-norm regularization for P. + /// Sets the L2-regularization parameter for P. pub fn lambda_p2(&mut self, value: f32) -> &mut Self { self.param.lambda_p2 = value; self } - /// Sets the coefficient of L1-norm regularization for Q. + /// Sets the L1-regularization parameter for Q. pub fn lambda_q1(&mut self, value: f32) -> &mut Self { self.param.lambda_q1 = value; self } - /// Sets the coefficient of L2-norm regularization for Q. + /// Sets the L2-regularization parameter for Q. pub fn lambda_q2(&mut self, value: f32) -> &mut Self { self.param.lambda_q2 = value; self