@codin-io/mlxd 1.0.41

package/README.md

@@ -0,0 +1,181 @@
+# `@codin/mlxd`
+
+**MLXD (Machine Learning eXperiment Deployment)** is a CI/CD testing tool for machine learning models. This CLI simplifies testing, configuration, and encryption of ML model performance metrics in a secure, standalone manner.
+
+## **Features**
+
+- **Run ML Tests**: Evaluate model accuracy, precision, and other metrics.
+- **Fully Configurable**: Easily define model paths, datasets, and test criteria in `config.yaml`.
+
+## **Quick Start**
+
+### **1. Initialize Configuration**
+
+Run:
+
+```bash
+mlxd init
+```
+
+This creates a `config.yaml` file in the current directory with the following structure:
+
+```yaml
+modelPath: "./my_model.pth" # Path to your ML model
+dataPath: "./data/test_data.csv" # Path to your test dataset
+tests:
+  - name: "Model Accuracy"
+    type: "metric_threshold"
+    metric: "accuracy"
+    threshold: 0.85
+```
+
+### **2. Configure `config.yaml`**
+
+Edit the file to match your specific model and dataset paths:
+
+```yaml
+modelPath: "./models/mymodel.h5"
+dataPath: "./datasets/test.csv"
+tests:
+  - name: "Accuracy Test"
+    type: "metric_threshold"
+    metric: "accuracy"
+    threshold: 0.9
+```
+
+### **3. Run Tests**
+
+1. Run tests without encryption:
+
+   ```bash
+   mlxd run
+   ```
+
+   This outputs test results in the console.
+
+### **Initialization**
+
+- `mlxd init`  
+  Creates a `config.yaml` template in the current directory.
+
+### **Version**
+
+- `mlxd --version or -v`
+  Prints the CLI version.
+
+### **Run Tests**
+
+- `mlxd run`
+  - Runs tests defined in `config.yaml`.
+
+### **Uninstall**
+
+- `mlxd uninstall`
+  - Removes the CLI globally.
+
+## **Example Workflow**
+
+1. Install the CLI:
+
+   ```bash
+   npm install -g @codin/mlxd
+   ```
+
+2. Create `config.yaml`:
+
+   ```bash
+   mlxd init
+   ```
+
+3. Edit `config.yaml`:
+
+   ```yaml
+   modelPath: "./models/mymodel.h5"
+   dataPath: "./datasets/test.csv"
+   tests:
+     - name: "Accuracy Test"
+       type: "metric_threshold"
+       metric: "accuracy"
+       threshold: 0.9
+   ```
+
+4. Run tests:
+
+   ```bash
+   mlxd run
+   ```
+
+5. Uninstall:
+   ```bash
+   mlxd uninstall
+   ```
+
+## **Troubleshooting**
+
+### **1. Common Errors**
+
+- **No `config.yaml` found**:  
+  Run `mlxd init` to create a new configuration file.
+
+- **Model or dataset file not found**:  
+  Ensure the `modelPath` and `dataPath` in `config.yaml` point to valid files.
+
+### **2. Check Installed Version**
+
+```bash
+mlxd --version or -v
+```
+
+## **License**
+
+This project is licensed under the ISC License.
+
+---
+
+## **Usage Agreement**
+
+By installing or using the `@codin/mlxd` CLI tool, you acknowledge and agree to the following terms:
+
+### **1. Development Status**
+
+- This CLI tool is under active development and may undergo significant changes in functionality, structure, and features.
+- The current version provides limited functionality (Automated model performance checks) and may include experimental or unstable features.
+
+### **2. Usage Terms**
+
+- You are permitted to use this CLI tool solely for its intended purpose: testing machine learning models within your projects.
+- Redistribution, reverse engineering, or modification of the tool for commercial purposes without explicit permission from the authors is prohibited.
+- You are responsible for any actions or consequences arising from the use of this CLI tool, including but not limited to data handling and processing.
+
+### **3. Data Responsibility**
+
+- This CLI does not transmit or store any user data externally. However, you are responsible for ensuring the security and confidentiality of the datasets, models, and configuration files (`config.yaml`) used with the CLI.
+- It is your responsibility to comply with applicable data privacy, security, and governance laws while using this tool.
+
+### **4. Disclaimer of Warranty**
+
+- This CLI is provided on an "as-is" basis, without any guarantees or warranties, express or implied, including but not limited to fitness for a particular purpose, non-infringement, or merchantability.
+- The authors make no guarantee that the tool is free of errors, bugs, or vulnerabilities.
+
+### **5. Limitation of Liability**
+
+- The authors and contributors shall not be held liable for any direct, indirect, incidental, special, or consequential damages arising from the use or inability to use the CLI, even if advised of the possibility of such damages.
+
+### **6. Updates and Changes**
+
+- The tool may be updated frequently during development. These updates may alter or remove features without prior notice.
+- Users are encouraged to keep the CLI updated to ensure compatibility and access to the latest improvements.
+
+### **7. Feedback and Contributions**
+
+- By providing feedback, suggestions, or contributions to the project, you grant the authors a non-exclusive, royalty-free, worldwide license to use, modify, and distribute your contributions as part of the project.
+
+### **8. Termination of Use**
+
+- The authors reserve the right to revoke access to this CLI tool at any time if the terms of this agreement are violated.
+
+### **9. Governing License**
+
+- This tool is licensed under the [ISC License](./LICENSE). The terms of the ISC License apply in addition to this Usage Agreement.
+
+---

package/config.yaml

@@ -0,0 +1,17 @@
+tests:
+  - name: Model Accuracy
+    type: metric_threshold
+    metric: accuracy
+    threshold: 0.85
+dataPath: ./data/my_real_dataset.csv
+dataValidation:
+  requiredColumns:
+    - prompt
+    - expected_label
+  maxRows: 100000
+  checkNulls: true
+  checkStats: true
+  maxStdDev: 100
+environment:
+  pythonVersion: '3.8'
+  requiredPackages: {}

package/mlxd/README.md

@@ -0,0 +1,181 @@
+# `@codin/mlxd`
+
+**MLXD (Machine Learning eXperiment Deployment)** is a CI/CD testing tool for machine learning models. This CLI simplifies testing, configuration, and encryption of ML model performance metrics in a secure, standalone manner.
+
+## **Features**
+
+- **Run ML Tests**: Evaluate model accuracy, precision, and other metrics.
+- **Fully Configurable**: Easily define model paths, datasets, and test criteria in `config.yaml`.
+
+## **Quick Start**
+
+### **1. Initialize Configuration**
+
+Run:
+
+```bash
+mlxd init
+```
+
+This creates a `config.yaml` file in the current directory with the following structure:
+
+```yaml
+modelPath: "./my_model.pth" # Path to your ML model
+dataPath: "./data/test_data.csv" # Path to your test dataset
+tests:
+  - name: "Model Accuracy"
+    type: "metric_threshold"
+    metric: "accuracy"
+    threshold: 0.85
+```
+
+### **2. Configure `config.yaml`**
+
+Edit the file to match your specific model and dataset paths:
+
+```yaml
+modelPath: "./models/mymodel.h5"
+dataPath: "./datasets/test.csv"
+tests:
+  - name: "Accuracy Test"
+    type: "metric_threshold"
+    metric: "accuracy"
+    threshold: 0.9
+```
+
+### **3. Run Tests**
+
+1. Run tests without encryption:
+
+   ```bash
+   mlxd run
+   ```
+
+   This outputs test results in the console.
+
+### **Initialization**
+
+- `mlxd init`  
+  Creates a `config.yaml` template in the current directory.
+
+### **Version**
+
+- `mlxd --version or -v`
+  Prints the CLI version.
+
+### **Run Tests**
+
+- `mlxd run`
+  - Runs tests defined in `config.yaml`.
+
+### **Uninstall**
+
+- `mlxd uninstall`
+  - Removes the CLI globally.
+
+## **Example Workflow**
+
+1. Install the CLI:
+
+   ```bash
+   npm install -g @codin/mlxd
+   ```
+
+2. Create `config.yaml`:
+
+   ```bash
+   mlxd init
+   ```
+
+3. Edit `config.yaml`:
+
+   ```yaml
+   modelPath: "./models/mymodel.h5"
+   dataPath: "./datasets/test.csv"
+   tests:
+     - name: "Accuracy Test"
+       type: "metric_threshold"
+       metric: "accuracy"
+       threshold: 0.9
+   ```
+
+4. Run tests:
+
+   ```bash
+   mlxd run
+   ```
+
+5. Uninstall:
+   ```bash
+   mlxd uninstall
+   ```
+
+## **Troubleshooting**
+
+### **1. Common Errors**
+
+- **No `config.yaml` found**:  
+  Run `mlxd init` to create a new configuration file.
+
+- **Model or dataset file not found**:  
+  Ensure the `modelPath` and `dataPath` in `config.yaml` point to valid files.
+
+### **2. Check Installed Version**
+
+```bash
+mlxd --version or -v
+```
+
+## **License**
+
+This project is licensed under the ISC License.
+
+---
+
+## **Usage Agreement**
+
+By installing or using the `@codin/mlxd` CLI tool, you acknowledge and agree to the following terms:
+
+### **1. Development Status**
+
+- This CLI tool is under active development and may undergo significant changes in functionality, structure, and features.
+- The current version provides limited functionality (Automated model performance checks) and may include experimental or unstable features.
+
+### **2. Usage Terms**
+
+- You are permitted to use this CLI tool solely for its intended purpose: testing machine learning models within your projects.
+- Redistribution, reverse engineering, or modification of the tool for commercial purposes without explicit permission from the authors is prohibited.
+- You are responsible for any actions or consequences arising from the use of this CLI tool, including but not limited to data handling and processing.
+
+### **3. Data Responsibility**
+
+- This CLI does not transmit or store any user data externally. However, you are responsible for ensuring the security and confidentiality of the datasets, models, and configuration files (`config.yaml`) used with the CLI.
+- It is your responsibility to comply with applicable data privacy, security, and governance laws while using this tool.
+
+### **4. Disclaimer of Warranty**
+
+- This CLI is provided on an "as-is" basis, without any guarantees or warranties, express or implied, including but not limited to fitness for a particular purpose, non-infringement, or merchantability.
+- The authors make no guarantee that the tool is free of errors, bugs, or vulnerabilities.
+
+### **5. Limitation of Liability**
+
+- The authors and contributors shall not be held liable for any direct, indirect, incidental, special, or consequential damages arising from the use or inability to use the CLI, even if advised of the possibility of such damages.
+
+### **6. Updates and Changes**
+
+- The tool may be updated frequently during development. These updates may alter or remove features without prior notice.
+- Users are encouraged to keep the CLI updated to ensure compatibility and access to the latest improvements.
+
+### **7. Feedback and Contributions**
+
+- By providing feedback, suggestions, or contributions to the project, you grant the authors a non-exclusive, royalty-free, worldwide license to use, modify, and distribute your contributions as part of the project.
+
+### **8. Termination of Use**
+
+- The authors reserve the right to revoke access to this CLI tool at any time if the terms of this agreement are violated.
+
+### **9. Governing License**
+
+- This tool is licensed under the [ISC License](./LICENSE). The terms of the ISC License apply in addition to this Usage Agreement.
+
+---

package/mlxd/config.yaml

@@ -0,0 +1,17 @@
+tests:
+  - name: Model Accuracy
+    type: metric_threshold
+    metric: accuracy
+    threshold: 0.85
+dataPath: ./data/my_real_dataset.csv
+dataValidation:
+  requiredColumns:
+    - prompt
+    - expected_label
+  maxRows: 100000
+  checkNulls: true
+  checkStats: true
+  maxStdDev: 100
+environment:
+  pythonVersion: '3.8'
+  requiredPackages: {}