xy-scale 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +13 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,5 @@
1
- # Scale Array Object Utility for Data Processing - GitHub Repository
1
+ # xy-scale.js | Machine Learning Data Preparation Toolkit: XY Splitting, Feature Weighting, Standardization, and Normalization in JavaScript
2
+
2
3
 
3
4
  ## Overview
4
5
 
@@ -61,6 +62,17 @@ Designed for production environments, this function parses and scales feature da
61
62
  - `productionFeaturesConfig`: Scaling configuration for production data.
62
63
  - `productionFeaturesKeyNames`: Key names reflecting feature weights.
63
64
 
65
+ ## Helper Callback Functions for Custom Data Parsing
66
+
67
+ ### `parseFeatures`
68
+
69
+ The `parseFeatures` function is used to extract specific feature values from each row of data, defining what the model will use as input. By selecting relevant fields in the dataset, `parseFeatures` ensures only the necessary values are included in the model’s feature set, allowing for streamlined preprocessing and improved model performance.
70
+
71
+ ### `parseLabels`
72
+
73
+ The `parseLabels` function defines the target output (or labels) that the machine learning model will learn to predict. This function typically creates labels by comparing each row of data with a future data point, which is especially useful in time-series data for predictive tasks. In our example, `parseLabels` generates labels based on changes between the current and next rows, which can help the model learn to predict directional trends.
74
+
75
+
64
76
  ---
65
77
 
66
78
  ## Usage Examples
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xy-scale",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "main": "./index.js",
5
5
  "type": "module",
6
6
  "scripts": {