syft-flwr 0.1.2__py3-none-any.whl → 0.1.5__py3-none-any.whl

syft_flwr/__init__.py

@@ -1,6 +1,15 @@
-__version__ = "0.1.2"
+__version__ = "0.1.5"
 
 from syft_flwr.bootstrap import bootstrap
 from syft_flwr.run import run
 
 __all__ = ["bootstrap", "run"]
+
+
+# Register the mount provider for syft_rds when syft_flwr is initializedAdd commentMore actions
+from syft_rds.syft_runtime.mounts import register_mount_provider
+
+from .mounts import SyftFlwrMountProvider
+
+# Register the mount provider
+register_mount_provider("syft_flwr", SyftFlwrMountProvider())

syft_flwr/mounts.py

@@ -0,0 +1,62 @@
+import json
+import os
+from pathlib import Path
+from typing import List
+
+import tomli
+from loguru import logger
+from syft_core import Client
+from syft_rds.models import DockerMount, JobConfig
+from syft_rds.syft_runtime.mounts import MountProvider
+
+
+class SyftFlwrMountProvider(MountProvider):
+    def _simplify_config(self, config_path: Path, simplified_config_path: Path) -> None:
+        """
+        Simplify the config by removing the refresh_token and setting the data_dir to /app/SyftBox
+        in order to mount the config to the container.
+        """
+        with open(config_path, "r") as fp:
+            config = json.load(fp)
+            modified_config = config.copy()
+            modified_config["data_dir"] = "/app/SyftBox"
+            modified_config.pop("refresh_token", None)
+            with open(simplified_config_path, "w") as fp:
+                json.dump(modified_config, fp)
+
+    def get_mounts(self, job_config: JobConfig) -> List[DockerMount]:
+        client = Client.load()
+        client_email = client.email
+        flwr_app_data = client.app_data("flwr")
+
+        config_path = client.config_path
+        simplified_dir = client.config_path.parent / ".simplified_configs"
+        simplified_dir.mkdir(parents=True, exist_ok=True)
+        simplified_config_path = simplified_dir / f"{client_email}.config.json"
+        self._simplify_config(config_path, simplified_config_path)
+
+        # Read app name from pyproject.toml
+        with open(job_config.function_folder / "pyproject.toml", "rb") as fp:
+            toml_dict = tomli.load(fp)
+            syft_flwr_app_name = toml_dict["tool"]["syft_flwr"]["app_name"]
+
+        rpc_messages_source = Path(f"{flwr_app_data}/{syft_flwr_app_name}/rpc/messages")
+        rpc_messages_source.mkdir(parents=True, exist_ok=True)
+        os.chmod(rpc_messages_source, 0o777)
+
+        mounts = [
+            DockerMount(
+                source=simplified_config_path,
+                target="/app/config.json",
+                mode="ro",
+            ),
+            DockerMount(
+                source=rpc_messages_source,
+                target=f"/app/SyftBox/datasites/{client_email}/app_data/flwr/{syft_flwr_app_name}/rpc/messages",
+                mode="rw",
+            ),
+        ]
+
+        logger.debug(f"Mounts: {mounts}")
+
+        return mounts

{syft_flwr-0.1.2.dist-info → syft_flwr-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syft-flwr
-Version: 0.1.2
+Version: 0.1.5
 Summary: syft_flwr is an open source framework that facilitate federated learning projects using Flower over the SyftBox protocol
 License-File: LICENSE
 Requires-Python: >=3.9.2
@@ -8,10 +8,7 @@ Requires-Dist: flwr-datasets[vision]>=0.5.0
 Requires-Dist: flwr[simulation]==1.17.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: safetensors>=0.5.0
-Requires-Dist: syft-core==0.2.3
-Requires-Dist: syft-event==0.2.0
-Requires-Dist: syft-rds==0.1.0
-Requires-Dist: syft-rpc==0.2.0
+Requires-Dist: syft-rds==0.1.4
 Requires-Dist: tomli-w>=1.2.0
 Requires-Dist: tomli>=2.2.1
 Requires-Dist: typing-extensions>=4.13.0

{syft_flwr-0.1.2.dist-info → syft_flwr-0.1.5.dist-info}/RECORD

@@ -1,6 +1,4 @@
-README.md,sha256=G_f6v-mRbjX7u1EU1IT8jDBk4QG7Z3FlBDajen3kB0Y,350
-pyproject.toml,sha256=9xXaUPNxLw22C4aYYqOAFAyvcUa9wV2wVTxSlUUsX_o,1243
-syft_flwr/__init__.py,sha256=i9rBsTh9ChUYp0phPXT13pGdIj5J5et7efxV3C4RMto,127
+syft_flwr/__init__.py,sha256=n8U8g6H1Gkgy52rSe5dXsW837X6eQ9BkKeLVqAwJ5X8,426
 syft_flwr/bootstrap.py,sha256=-T6SRh_p6u6uWpbTPZ6-URsAfMQAI2jakpjZAh0UUlw,3690
 syft_flwr/cli.py,sha256=imctwdQMxQeGQZaiKSX1Mo2nU_-RmA-cGB3H4huuUeA,3274
 syft_flwr/config.py,sha256=4hwkovGtFOLNULjJwoGYcA0uT4y3vZSrxndXqYXquMY,821
@@ -8,6 +6,7 @@ syft_flwr/flower_client.py,sha256=jn0oTKf7ChSFd7DP5ZWi0P1BrNX6w2_Gcm4GqTxjIVM,32
 syft_flwr/flower_server.py,sha256=sJwSEqePmkmWKGFXm2E44Ugoc6aaz-6tM7UaeWM2-co,1353
 syft_flwr/flwr_compatibility.py,sha256=vURf9rfsZ1uPm04szw6RpGYxtlG3BE4tW3YijptiGyk,3197
 syft_flwr/grid.py,sha256=Me2tivW0v1ApTjdjQffUc9f1UCHh1LtkYcKUjE82iZ8,7735
+syft_flwr/mounts.py,sha256=ry3_3eD4aPkRahk9eibfu88TpQjgp_KQ96G7yj692x4,2319
 syft_flwr/run.py,sha256=OPW9bVt366DT-U-SxMpMLNXASwTZjp7XNNXfDP767f4,2153
 syft_flwr/run_simulation.py,sha256=t3shhfzAWDUlf6iQmwf5sS9APZQE9mkaZ9MLCYs9Ng0,6922
 syft_flwr/serde.py,sha256=5fCI-cRUOh5wE7cXQd4J6jex1grRGnyD1Jx-VlEDOXM,495
@@ -15,8 +14,8 @@ syft_flwr/utils.py,sha256=3dDYEB7btq9hxZ9UsfQWh3i44OerAhGXc5XaX5wO3-o,955
 syft_flwr/strategy/__init__.py,sha256=mpUmExjjFkqU8gg41XsOBKfO3aqCBe7XPJSU-_P7smU,97
 syft_flwr/strategy/fedavg.py,sha256=N8jULUkjvuaBIEVINowyQln8W8yFhkO-J8k0-iPcGMA,1562
 syft_flwr/templates/main.py.tpl,sha256=p0uK97jvLGk3LJdy1_HF1R5BQgIjaTGkYnr-csfh39M,791
-syft_flwr-0.1.2.dist-info/METADATA,sha256=cd0V-f0x01A5_lZtNbAheCiT9yOAtUB463x8K7RpxJY,994
-syft_flwr-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-syft_flwr-0.1.2.dist-info/entry_points.txt,sha256=o7oT0dCoHn-3WyIwdDw1lBh2q-GvhB_8s0hWeJU4myc,49
-syft_flwr-0.1.2.dist-info/licenses/LICENSE,sha256=0msOUar8uPZTqkAOTBp4rCzd7Jl9eRhfKiNufwrsg7k,11361
-syft_flwr-0.1.2.dist-info/RECORD,,
+syft_flwr-0.1.5.dist-info/METADATA,sha256=czIreQ7KbqGnfuO9WFo84ffPM2uvXNXPQojNZPFYCSg,898
+syft_flwr-0.1.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+syft_flwr-0.1.5.dist-info/entry_points.txt,sha256=o7oT0dCoHn-3WyIwdDw1lBh2q-GvhB_8s0hWeJU4myc,49
+syft_flwr-0.1.5.dist-info/licenses/LICENSE,sha256=0msOUar8uPZTqkAOTBp4rCzd7Jl9eRhfKiNufwrsg7k,11361
+syft_flwr-0.1.5.dist-info/RECORD,,

README.md

@@ -1,8 +0,0 @@
-# syft_flwr
-
-`syft_flwr` is an open source framework that facilitate federated learning projects using [Flower](https://github.com/adap/flower) over the [SyftBox](https://github.com/OpenMined/syftbox) protocol
-
-## Installation
-- Install uv: `brew install uv`
-- Create a virtual environment: `uv venv`
-- Install `syft-flwr`: `uv pip install syft-flwr`

pyproject.toml

@@ -1,52 +0,0 @@
-[project]
-name = "syft-flwr"
-version = "0.1.2"
-description = "syft_flwr is an open source framework that facilitate federated learning projects using Flower over the SyftBox protocol"
-readme = "README.md"
-requires-python = ">=3.9.2"
-dependencies = [
-    "flwr[simulation]==1.17.0",
-    "flwr-datasets[vision]>=0.5.0",
-    "loguru>=0.7.3",
-    "safetensors>=0.5.0",
-    "typing-extensions>=4.13.0",
-    "tomli>=2.2.1",
-    "tomli-w>=1.2.0",
-    "syft-core==0.2.3",
-    "syft-event==0.2.0",
-    "syft-rpc==0.2.0",
-    "syft-rds==0.1.0",
-]
-
-[project.scripts]
-syft_flwr = "syft_flwr.cli:main"
-
-[tool.uv]
-dev-dependencies = [
-    "ipykernel>=6.29.5",
-    "ipywidgets>=8.1.6",
-    "pytest>=8.3.4",
-    "pre-commit>=4.0.1",
-]
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/syft_flwr"]
-only-include = ["src", "pyproject.toml", "/README.md"]
-exclude = ["src/**/__pycache__"]
-
-[tool.hatch.build.targets.sdist]
-only-include = ["src", "pyproject.toml", "/README.md"]
-exclude = ["src/**/__pycache__", "examples", "notebooks", "justfile"]
-
-[tool.ruff]
-exclude = [".archive"]
-
-[tool.ruff.lint]
-extend-select = ["I"]
-
-[tool.ruff.lint.per-file-ignores]
-"**/__init__.py" = ["F401"]