add readme

chachaleo · Dec 21, 2023 · d502465 · d502465
1 parent 6747b0d
commit d502465
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 8 deletions.
diff --git a/docs/framework/operators/machine-learning/linear-classifier/README.md b/docs/framework/operators/machine-learning/linear-classifier/README.md
@@ -0,0 +1,22 @@
+# Linear Classifier
+
+`LinearClassifierTrait` provides a trait definition for linear classification problem.
+
+```rust
+use orion::operators::ml::LinearClassificationTrait;
+```
+
+### Data types
+
+Orion supports currently only fixed point data types for `LinearClassificationTrait`.
+
+| Data type            | dtype                                                         |
+| -------------------- | ------------------------------------------------------------- |
+| Fixed point (signed) | `LinearClassifierTrait<FP8x23 \| FP16x16 \| FP64x64 \| FP32x32>` |
+
+
+***
+
+| function | description |
+| --- | --- |
+| [`linear_classifier.predict`](linear_classifier.predict.md) | Performs the linear classification evaluation. |
diff --git a/tests/lib.cairo b/tests/lib.cairo
@@ -1,8 +1,8 @@
-//mod numbers;
-//mod performance;
-//mod tensor_core;
-//mod nodes;
+mod numbers;
+mod performance;
+mod tensor_core;
+mod nodes;
 mod ml;
-//mod operators;
+mod operators;
 
 
diff --git a/tests/ml.cairo b/tests/ml.cairo
@@ -1,5 +1,5 @@
-//mod tree_ensemble_classifier;
-//mod tree_ensemble_regressor;
-//mod linear_regressor_test;
+mod tree_ensemble_classifier;
+mod tree_ensemble_regressor;
+mod linear_regressor_test;
 mod linear_classifier_test;