Merge pull request #299 from claimed-framework/merge-mlx

Merge mlx

Author: romeokienzler

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - MLX Version [e.g. 22]
+
+**Additional context**
+
+Add any other context about the problem here.

.github/workflows/publish-pypi.yml

@@ -0,0 +1,37 @@
+name: Build and publish Python package
+
+on:
+  push:
+    tags:
+      - 'v*'                  # publish only on tag pushes like v1.2.3
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0       # necessary for setuptools_scm to see tags
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install build & twine
+        run: python -m pip install --upgrade pip build twine setuptools_scm
+
+      - name: Build sdist and wheel
+        run: python -m build --sdist --wheel
+
+      - name: Check artifacts
+        run: ls -l dist
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m twine check dist/*
+          python -m twine upload dist/* --non-interactive

.gitignore

@@ -1,4 +1,4 @@
 venv/
 .venv/
 __pycache__
-.ipynb_checkpoints/
+.ipynb_checkpoints/

MAINTAINERS.md

@@ -0,0 +1,8 @@
+# MAINTAINERS
+
+Following is the current list of maintainers on this project
+
+The maintainers are listed in alphabetical order.
+
+- [@romeokienzler](https://github.com/romeokienzler) (Romeo Kienzler)
+- [@GlennVerhaag](https://github.com/GlennVerhaag) (Glenn Verhaag)

OWNERS

@@ -0,0 +1,12 @@
+approvers:
+ - animeshsingh
+ - ckadner
+ - Tomcli
+ - drewbutlerbb4
+ - yhwang
+reviewers:
+ - animeshsingh
+ - ckadner
+ - Tomcli
+ - drewbutlerbb4
+ - yhwang

README.md

@@ -57,4 +57,4 @@ Interested in helping make CLAIMED better? We encourage you to take a look at ou
 CLAIMED is supported by the EU’s Horizon Europe program under Grant Agreement number 101131841 and also received funding from the Swiss State Secretariat for Education, Research and Innovation (SERI) and the UK Research and Innovation (UKRI).
 
 ## License
-This software is released under Apache License v2.0.
+This software is released under Apache License v2.0.

pyproject.toml

@@ -47,4 +47,4 @@ c3_create_gridwrapper = "c3.create_gridwrapper:main"
 where = ["src"]
 
 [tool.setuptools.package-data]
-"c3.templates" = ["*"]
+"c3.templates" = ["*"]

src/mlx/__init__.py

@@ -0,0 +1,111 @@
+import json
+import boto3
+import jsonschema
+from jsonschema import validate
+import os
+
+class COSKVStore:
+    def __init__(self, bucket_name, schema, cos_client=None):
+        """
+        Initialize the COS Key-Value store.
+        :param bucket_name: Name of the COS bucket.
+        :param schema: JSON Schema to validate values.
+        :param cos_client: Optional COS client instance (for dependency injection).
+        """
+        self.bucket_name = bucket_name
+        self.schema = schema
+        self.cos_client = cos_client or boto3.client('s3')
+
+    def put(self, key, value):
+        """
+        Store a value in COS after validating against the JSON schema.
+        :param key: The key under which the value is stored.
+        :param value: The value to store (must be JSON-serializable).
+        """
+        try:
+            validate(instance=value, schema=self.schema)
+        except jsonschema.exceptions.ValidationError as e:
+            raise ValueError(f"Validation error: {e.message}")
+        self.cos_client.put_object(
+            Bucket=self.bucket_name,
+            Key=key,
+            Body=json.dumps(value)
+        )
+
+    def get(self, key):
+        """
+        Retrieve a value from COS.
+        :param key: The key to retrieve.
+        :return: The stored value as a dictionary.
+        """
+        try:
+            response = self.cos_client.get_object(Bucket=self.bucket_name, Key=key)
+            return json.loads(response['Body'].read().decode('utf-8'))
+        except self.cos_client.exceptions.NoSuchKey:
+            raise KeyError(f"Key '{key}' not found in bucket '{self.bucket_name}'")
+
+    def delete(self, key):
+        """
+        Delete a key-value pair from COS.
+        :param key: The key to delete.
+        """
+        self.cos_client.delete_object(Bucket=self.bucket_name, Key=key)
+
+    def list_keys(self):
+        """
+        List all keys in the COS bucket.
+        :return: A list of keys.
+        """
+        response = self.cos_client.list_objects_v2(Bucket=self.bucket_name)
+        return [obj['Key'] for obj in response.get('Contents', [])]
+
+def load_schemas(schema_folder):
+    """
+    Loads all JSON schemas from the given folder.
+    :param schema_folder: Path to the folder containing JSON schema files.
+    :return: A dictionary of schema names and their corresponding JSON objects.
+    """
+    schemas = {}
+    for filename in os.listdir(schema_folder):
+        if filename.endswith(".json"):
+            filepath = os.path.join(schema_folder, filename)
+            with open(filepath, 'r') as f:
+                schemas[filename[:-5]] = json.load(f)
+    return schemas
+
+# Example Usage
+if __name__ == "__main__":
+    schema_folder = "../schemas"  
+    schemas = load_schemas(schema_folder)
+
+    if "example_schema" in schemas:
+        example_schema = schemas["example_schema"]
+        cos_store = COSKVStore("my-cos-bucket", example_schema)
+
+        test_data = {
+            "id": "model_123",
+            "name": "MyModel",
+            "framework": "TensorFlow",
+            "version": "2.10",
+            "description": "A simple neural network model.",
+            "metrics": {
+                "accuracy": 0.95,
+                "loss": 0.1
+            }
+        }
+        cos_store.put("model_123", test_data)
+        print(cos_store.get("model_123"))
+
+        #Example data without the metric key, which is not required
+        test_data_no_metrics = {
+            "id": "model_456",
+            "name": "MyOtherModel",
+            "framework": "PyTorch",
+            "version": "1.12",
+            "description": "Another neural network model.",
+        }
+        cos_store.put("model_456", test_data_no_metrics)
+        print(cos_store.get("model_456"))
+
+    else:
+        print("Schema 'example_schema' not found.")