FedModelKit 0.8.0__tar.gz → 0.9.3__tar.gz

fedmodelkit-0.9.3/.gitlab-ci.yml

@@ -0,0 +1,47 @@
+image: python:3.12-slim
+
+stages:
+  - check
+  - build
+  - publish
+
+variables:
+  UV_VERSION: "0.5.18"
+
+# Install uv once and reuse across jobs
+.uv-base:
+  before_script:
+    - pip install uv==$UV_VERSION
+
+check_project:
+  stage: check
+  extends: .uv-base
+  script:
+    - uv lock --check
+    - uv build --sdist
+
+build_package:
+  stage: build
+  extends: .uv-base
+  script:
+    - uv build
+  artifacts:
+    paths:
+      - dist/
+  rules:
+    - if: $CI_COMMIT_TAG
+
+publish_to_pypi:
+  stage: publish
+  extends: .uv-base
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: https://pypi.org
+  script:
+    - uv pip install --system twine
+    - TWINE_USERNAME=__token__ TWINE_PASSWORD=$PYPI_ID_TOKEN twine upload
+      --verbose dist/*
+  rules:
+    - if: $CI_COMMIT_TAG
+  dependencies:
+    - build_package

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FedModelKit
-Version: 0.8.0
+Version: 0.9.3
 Summary: Tools to scaffold and run privacy-preserving federated learning experiments across distributed data sites.
 Author-email: ceresale <alessandro.ceresi@upm.es>
 License-File: LICENSE

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "FedModelKit"
-version = "0.8.0"
+version = "0.9.3"
 description = "Tools to scaffold and run privacy-preserving federated learning experiments across distributed data sites."
 readme = "README.md"
 authors = [

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/src/FedModelKit/cli.py

@@ -36,6 +36,7 @@ def create_structure(exp_name: str = "new_experiment") -> None:
     structure = {
         f"{exp_name}": {
             "pyproject.toml": get_pyproject(exp_name),
+            ".python-version": "3.12",
             f"{exp_name}": {
                 "__init__.py": get_init(),
                 "task.py": get_task(),

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/src/FedModelKit/mlflow_service/server.py

@@ -276,7 +276,7 @@ class MLflowServerCoordinator:
                 
                 coordination_message = Message(
                     content=recordset,
-                    message_type="query.mlflow.coordination",
+                    message_type="query.mlflow_coordination",
                     dst_node_id=node_id,
                     group_id="mlflow_coordination",
                     ttl=DEFAULT_TTL,

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/src/FedModelKit/templates/ds.ipynb

@@ -67,6 +67,15 @@
                 "<img src=\"./images/dsLogsInAsGuests.png\" width=\"53%\" alt=\"DS logs into DOs' datasites as guests\">"
             ]
         },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "!uv sync"
+            ]
+        },
         {
             "cell_type": "code",
             "execution_count": null,
@@ -80,10 +89,14 @@
                 "DS = Client.load().email\n",
                 "logger.info(f\"DS's email: {DS}\")\n",
                 "\n",
+                "USE_RDS_DASHBOARD = False\n",
+                "ds = sy.init_session(host=DS, email=DS, start_syft_event_server=not USE_RDS_DASHBOARD)\n",
+                "\n",
                 "DO1 = \"data.owner1@example.com\"\n",
                 "DO2 = \"data.owner2@example.com\"\n",
-                "do1_guest = sy.init_session(host=DO1)\n",
-                "do2_guest = sy.init_session(host=DO2)"
+                "\n",
+                "do1_guest = sy.init_session(host=DO1, email=DS)\n",
+                "do2_guest = sy.init_session(host=DO2, email=DS)"
             ]
         },
         {
@@ -270,17 +283,18 @@
                 "\n",
                 "try:\n",
                 "    !rm -rf {SYFT_FLWR_PROJECT_PATH / \"main.py\"}\n",
+                "    logger.info(f\"syft_flwr version = {syft_flwr.__version__}\")\n",
                 "    syft_flwr.bootstrap(SYFT_FLWR_PROJECT_PATH, aggregator=DS, datasites=do_emails)\n",
-                "    print(\"Bootstrapped project successfully ✅\")\n",
+                "    logger.info(\"Bootstrapped project successfully ✅\")\n",
                 "except Exception as e:\n",
-                "    print(e)"
+                "    logger.error(e)"
             ]
         },
         {
             "cell_type": "markdown",
             "metadata": {},
             "source": [
-                "## ▶️ Start MLflow (local)\n",
+                "## ▶️ Start MLflow (for local simulation)\n",
                 "\n",
                 "Run this in a terminal:\n",
                 "```bash\n",
@@ -308,7 +322,10 @@
                 "os.environ[\"MLFLOW_EXP_NAME\"] = \"EXPERIMENT_NAME\"\n",
                 "os.environ[\"MLFLOW_CLIENT_EMAILS\"] = \",\".join(do_emails)\n",
                 "os.environ[\"MLFLOW_ENABLE_LOGGING\"] = \"true\"\n",
-                "os.environ[\"MLFLOW_TRACKING_URI\"] = \"http://localhost:5000\""
+                "os.environ[\"MLFLOW_TRACKING_URI\"] = \"\" # For simulation http://localhost:5000\n",
+                "os.environ[\"MLFLOW_TRACKING_USERNAME\"] = \"\" # For simulation leave empty\n",
+                "os.environ[\"MLFLOW_TRACKING_TOKEN\"] = \"\" # For simulation leave empty\n",
+                "os.environ[\"MLFLOW_WORKSPACE\"] = \"\" # For simulation leave empty"
             ]
         },
         {
@@ -420,14 +437,14 @@
             "metadata": {},
             "outputs": [],
             "source": [
-                "print(f\"sending job to {do1_guest.host}\")\n",
+                "logger.info(f\"sending job to {do1_guest.host}\")\n",
                 "job = do1_guest.job.submit(\n",
                 "    name=\"EXPERIMENT_NAME\",\n",
                 "    user_code_path=SYFT_FLWR_PROJECT_PATH,\n",
                 "    dataset_name=SYFTBOX_DATASET_NAME,\n",
                 "    entrypoint=\"main.py\",\n",
                 ")\n",
-                "print(job)"
+                "logger.success(job)"
             ]
         },
         {
@@ -436,14 +453,14 @@
             "metadata": {},
             "outputs": [],
             "source": [
-                "print(f\"sending job to {do2_guest.host}\")\n",
+                "logger.info(f\"sending job to {do2_guest.host}\")\n",
                 "job = do2_guest.job.submit(\n",
                 "    name=\"EXPERIMENT_NAME\",\n",
                 "    user_code_path=SYFT_FLWR_PROJECT_PATH,\n",
                 "    dataset_name=SYFTBOX_DATASET_NAME,\n",
                 "    entrypoint=\"main.py\",\n",
                 ")\n",
-                "print(job)"
+                "logger.success(job)"
             ]
         },
         {
@@ -473,7 +490,44 @@
             "metadata": {},
             "outputs": [],
             "source": [
-                "!uv run {str(SYFT_FLWR_PROJECT_PATH / \"main.py\")} --active"
+                "job = ds.job.submit(\n",
+                "    name=\"EXPERIMENT_NAME_DS\",\n",
+                "    user_code_path=SYFT_FLWR_PROJECT_PATH,\n",
+                "    entrypoint=\"main.py\",\n",
+                ")\n",
+                "job"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "ds.job.get_all()"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "ds.job.approve(job)"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "import os\n",
+                "\n",
+                "os.environ[\"LOGURU_LEVEL\"] = \"DEBUG\"\n",
+                "os.environ[\"SYFT_FLWR_MSG_TIMEOUT\"] = \"120\"\n",
+                "\n",
+                "ds.run_private(ds.job.get_all()[0], blocking=True)"
             ]
         },
         {
@@ -493,6 +547,25 @@
                 "<img src=\"./images/dsAggregatedWeights.png\" width=\"35%\" alt=\"DS weights\">"
             ]
         },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "ds.job.show_logs(job)\n",
+                "ds.job.get_output_dir(job)"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "execution_count": null,
+            "metadata": {},
+            "outputs": [],
+            "source": [
+                "ds.job.delete_all()"
+            ]
+        },
         {
             "cell_type": "markdown",
             "metadata": {},
@@ -520,4 +593,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 2
-}
+}

fedmodelkit-0.9.3/src/FedModelKit/templates/extern_pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "EXPERIMENT_NAME"
+version = "0.1.0"
+description = "Description of the experiment"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "FedModelKit>=0.9.3",
+    "imblearn>=0.0",
+    "jupyterlab>=4.4.4",
+    "loguru>=0.7.3",
+    "scikit-learn==1.6.1",
+    "torch==2.7.0",
+    "ray>=2.47.1",
+    "syft-client==0.1.94",
+    "syft-core==0.3.0",
+    "syft-crypto==0.1.2",
+    "syft-dataset==0.1.5",
+    "syft-event==0.4.3",
+    "syft-flwr==0.5.1",
+    "syft-job==0.1.39",
+    "syft-notebook-ui==0.1.1",
+    "syft-permissions==0.1.14",
+    "syft-perms==0.1.14",
+    "syft-rds==0.5.0",
+    "syft-rpc==0.4.1",
+]

{fedmodelkit-0.8.0 → fedmodelkit-0.9.3}/src/FedModelKit/templates/pyproject.toml

@@ -10,13 +10,24 @@ version = "1.0.0"
 description = "Description of the experiment"
 license = "Apache-2.0"
 dependencies = [    
-    "FedModelKit>=0.7.0",
+    "FedModelKit>=0.9.3",
     "imblearn>=0.0",
     "jupyterlab>=4.4.4",
     "loguru>=0.7.3",
     "scikit-learn==1.6.1",
-    "syft-flwr>=0.4.0",
     "torch==2.7.0",
+    "syft-client==0.1.94",
+    "syft-core==0.3.0",
+    "syft-crypto==0.1.2",
+    "syft-dataset==0.1.5",
+    "syft-event==0.4.3",
+    "syft-flwr==0.5.1",
+    "syft-job==0.1.39",
+    "syft-notebook-ui==0.1.1",
+    "syft-permissions==0.1.14",
+    "syft-perms==0.1.14",
+    "syft-rds==0.5.0",
+    "syft-rpc==0.4.1",
 ]
 
 [tool.hatch.build.targets.wheel]