diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 92b64b9d4b1..f75f322da40 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,7 +52,8 @@ repos: packages/syft/src/syft/proto.*| packages/syft/tests/syft/lib/python.*| packages/grid.*| - packages/syft/src/syft/federated/model_serialization/protos.py + packages/syft/src/syft/federated/model_serialization/protos.py| + packages/syft/src/syft/service/model/model.py )$ - repo: https://github.com/MarcoGorelli/absolufy-imports diff --git a/notebooks/api/0.8/05-custom-policy.ipynb b/notebooks/api/0.8/05-custom-policy.ipynb index 819d7fc934e..69b25ed410b 100644 --- a/notebooks/api/0.8/05-custom-policy.ipynb +++ b/notebooks/api/0.8/05-custom-policy.ipynb @@ -628,7 +628,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.12.4" + "version": "3.12.2" }, "toc": { "base_numbering": 1, diff --git a/notebooks/experimental/Digital Signatures/ds-benchmarks.ipynb b/notebooks/experimental/Digital Signatures/ds-benchmarks.ipynb new file mode 100644 index 00000000000..5ff803cdce6 --- /dev/null +++ b/notebooks/experimental/Digital Signatures/ds-benchmarks.ipynb @@ -0,0 +1,429 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 5, + "id": "f272a63f-03a9-417d-88c3-11a98ad25c80", + "metadata": {}, + "outputs": [], + "source": [ + "data = b\"A\" * (10**9) # 1GB message" + ] + }, + { + "cell_type": "markdown", + "id": "d9a2e0c0-ef3b-41be-a4e8-0d9f190a1106", + "metadata": {}, + "source": [ + "# Using PyNacl" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "a4145072-a959-479b-8c80-da15f82946f3", + "metadata": {}, + "outputs": [], + "source": [ + "# stdlib\n", + "import hashlib\n", + "import time\n", + "\n", + "# third party\n", + "from nacl.signing import SigningKey\n", + "\n", + "# Generate a new random signing key\n", + "signing_key = SigningKey.generate()\n", + "\n", + "# Example large message\n", + "large_message = data\n", + "\n", + "# Hash the message with SHA-256 using hashlib\n", + "start = time.time()\n", + "hash_object = hashlib.sha256()\n", + "hash_object.update(large_message)\n", + "hashed_message = hash_object.digest()\n", + "hash_time = time.time() - start\n", + "\n", + "# Sign the hashed message with PyNaCl\n", + "start = time.time()\n", + "signed_hash = signing_key.sign(hashed_message)\n", + "sign_time = time.time() - start\n", + "\n", + "# Directly sign the large message with PyNaCl\n", + "start = time.time()\n", + "signed_message = signing_key.sign(large_message)\n", + "direct_sign_time = time.time() - start\n", + "\n", + "print(f\"Time to hash with hashlib: {hash_time:.2f} seconds\")\n", + "print(f\"Time to sign hashed message with PyNaCl: {sign_time:.2f} seconds\")\n", + "print(f\"Total time (hash + sign): {hash_time + sign_time:.2f} seconds\")\n", + "print(\n", + " f\"Time to directly sign large message with PyNaCl: {direct_sign_time:.2f} seconds\"\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "d8581767-bee2-42e1-a571-148cf0fb12a4", + "metadata": {}, + "source": [ + "# Using Cryptography library" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "8ea32e21-8987-4459-aa0f-6bc832376ab7", + "metadata": {}, + "outputs": [], + "source": [ + "# !pip install cryptography" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "1618c35b-cb6e-4f28-a13c-a2e23497841c", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "%%time\n", + "# third party\n", + "from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey\n", + "\n", + "private_key = Ed25519PrivateKey.generate()\n", + "signature = private_key.sign(data)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9abb35b3-1891-4074-8f0e-729de0c2e4a2", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "%%time\n", + "# third party\n", + "from cryptography.hazmat.primitives.asymmetric.ed448 import Ed448PrivateKey\n", + "\n", + "private_key = Ed448PrivateKey.generate()\n", + "signature = private_key.sign(data)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "66341fe5-94c3-4c8e-af34-a2e837a6957f", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "%%time\n", + "# third party\n", + "from cryptography.hazmat.primitives import hashes\n", + "from cryptography.hazmat.primitives.asymmetric import dsa\n", + "\n", + "private_key = dsa.generate_private_key(\n", + " key_size=1024,\n", + ")\n", + "signature = private_key.sign(data, hashes.SHA256())" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "83362239-6376-46ee-8e70-d9a23ff5421b", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "\n", + "# third party\n", + "from cryptography.hazmat.primitives import hashes\n", + "from cryptography.hazmat.primitives.asymmetric import ec\n", + "\n", + "private_key = ec.generate_private_key(ec.SECP384R1())\n", + "\n", + "signature = private_key.sign(data, ec.ECDSA(hashes.SHA256()))" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "cd5d1781-666e-4d19-aee9-c0ad4b8f0756", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "public_key = private_key.public_key()\n", + "public_key.verify(signature, data, ec.ECDSA(hashes.SHA256()))" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "206369da-d2c7-424c-b5c6-b1d9b5202786", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "%%time\n", + "# third party\n", + "from cryptography.hazmat.primitives import hashes\n", + "from cryptography.hazmat.primitives.asymmetric import padding\n", + "from cryptography.hazmat.primitives.asymmetric import rsa\n", + "\n", + "private_key = rsa.generate_private_key(\n", + " public_exponent=65537,\n", + " key_size=2048,\n", + ")\n", + "\n", + "message = data\n", + "signature = private_key.sign(\n", + " message,\n", + " padding.PSS(mgf=padding.MGF1(hashes.SHA256()), salt_length=padding.PSS.MAX_LENGTH),\n", + " hashes.SHA256(),\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b222c11a-e2a2-4610-a9d8-95ee3343d466", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "public_key = private_key.public_key()\n", + "message = data\n", + "public_key.verify(\n", + " signature,\n", + " message,\n", + " padding.PSS(mgf=padding.MGF1(hashes.SHA256()), salt_length=padding.PSS.MAX_LENGTH),\n", + " hashes.SHA256(),\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "6fa46875-4405-47c6-855c-0b3f407aa26c", + "metadata": {}, + "source": [ + "# Hashing by PyNacl" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "ea204831-482d-4d3a-988b-32920b7af285", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import nacl.encoding\n", + "import nacl.hash\n", + "\n", + "methods = [\"sha256\", \"sha512\", \"blake2b\"]\n", + "\n", + "for hash_method in methods:\n", + " HASHER = getattr(nacl.hash, hash_method)\n", + "\n", + " start = time.time()\n", + " digest = HASHER(data, encoder=nacl.encoding.HexEncoder)\n", + " end = time.time()\n", + " print(f\"Time taken for {hash_method}\", end - start)" + ] + }, + { + "cell_type": "markdown", + "id": "df81c37d-024e-4de8-a136-717f2e67e724", + "metadata": {}, + "source": [ + "# Hashing by cryptography library" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "2a775385-6b57-46ab-9aed-51598a8c7592", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "from cryptography.hazmat.primitives import hashes\n", + "\n", + "methods = [\"SHA256\", \"SHA512\", \"BLAKE2b\"]\n", + "\n", + "for hash_method in methods:\n", + " if hash_method == \"BLAKE2b\":\n", + " digest = hashes.Hash(getattr(hashes, hash_method)(64))\n", + " else:\n", + " digest = hashes.Hash(getattr(hashes, hash_method)())\n", + "\n", + " start = time.time()\n", + " digest.update(data)\n", + " digest.finalize()\n", + " end = time.time()\n", + " print(f\"Time taken for {hash_method}\", end - start)" + ] + }, + { + "cell_type": "markdown", + "id": "086ab235-d9a0-4184-8270-bffb088bf1c3", + "metadata": {}, + "source": [ + "# Hashing by python hashlib" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b08d7f82-ea8f-4b24-ac09-669526894293", + "metadata": {}, + "outputs": [], + "source": [ + "methods = [\"sha256\", \"sha512\", \"blake2b\"]\n", + "\n", + "for hash_method in methods:\n", + " if hash_method == \"blake2b\":\n", + " m = getattr(hashlib, hash_method)(digest_size=64)\n", + " else:\n", + " m = getattr(hashlib, hash_method)()\n", + "\n", + " start = time.time()\n", + " m.update(data)\n", + " m.digest()\n", + " end = time.time()\n", + " print(f\"Time taken for {hash_method}\", end - start)" + ] + }, + { + "cell_type": "code", + "execution_count": 1, + "id": "9bf2843e-add6-4f65-a75b-5ef93093d347", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Collecting pycryptodome\n", + " Downloading pycryptodome-3.20.0-cp35-abi3-macosx_10_9_universal2.whl.metadata (3.4 kB)\n", + "Downloading pycryptodome-3.20.0-cp35-abi3-macosx_10_9_universal2.whl (2.4 MB)\n", + "\u001b[2K \u001b[38;2;114;156;31m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m2.4/2.4 MB\u001b[0m \u001b[31m11.9 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m31m12.5 MB/s\u001b[0m eta \u001b[36m0:00:01\u001b[0m\n", + "\u001b[?25hInstalling collected packages: pycryptodome\n", + "Successfully installed pycryptodome-3.20.0\n", + "\n", + "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m24.0\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m24.1.2\u001b[0m\n", + "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n" + ] + } + ], + "source": [ + "!pip install pycryptodome" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "4343bedd-308a-4caf-a4ff-56cdd3ca2433", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Public Key:\n", + "-----BEGIN PUBLIC KEY-----\n", + "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEz1vchLT61W1+TWg86POU/jsYS4IJ\n", + "IzeBv+mYc9Ehpn0MqCpri5l0+HbnIpLAdvO7KeYRGBRqFPJMjqt5rB30Aw==\n", + "-----END PUBLIC KEY-----\n", + "\n", + "Private Key:\n", + "-----BEGIN PRIVATE KEY-----\n", + "MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgSIn/SVjK1hLXs5XK\n", + "S7C+dB1YcSz9VqStzP1ytSL9y7ihRANCAATPW9yEtPrVbX5NaDzo85T+OxhLggkj\n", + "N4G/6Zhz0SGmfQyoKmuLmXT4duciksB287sp5hEYFGoU8kyOq3msHfQD\n", + "-----END PRIVATE KEY-----\n", + "\n", + "Signature:\n", + "108b92beb9b85840c39e217373c998fb6df71baabb6a39cae6088f4a1f920d66694b1a71df082d930f58d91e83b72eee6aaa77f865796a78671d5bb74d384866\n", + "CPU times: user 4.9 s, sys: 41.8 ms, total: 4.94 s\n", + "Wall time: 4.94 s\n" + ] + } + ], + "source": [ + "# third party\n", + "from Crypto.Hash import SHA256\n", + "\n", + "%%time\n", + "# third party\n", + "from Crypto.PublicKey import ECC\n", + "from Crypto.Signature import DSS\n", + "\n", + "# Generate a new ECC key pair\n", + "key = ECC.generate(curve=\"P-256\")\n", + "\n", + "# Export the public key in PEM format\n", + "public_key_pem = key.public_key().export_key(format=\"PEM\")\n", + "print(\"Public Key:\")\n", + "print(public_key_pem)\n", + "\n", + "# Export the private key in PEM format\n", + "private_key_pem = key.export_key(format=\"PEM\")\n", + "print(\"\\nPrivate Key:\")\n", + "print(private_key_pem)\n", + "\n", + "# Sign a message\n", + "message = data\n", + "hash_obj = SHA256.new(message)\n", + "signer = DSS.new(key, \"fips-186-3\")\n", + "signature = signer.sign(hash_obj)\n", + "print(\"\\nSignature:\")\n", + "print(signature.hex())\n", + "\n", + "# # Verify the signature\n", + "# public_key = ECC.import_key(public_key_pem)\n", + "# verifier = DSS.new(public_key, 'fips-186-3')\n", + "# try:\n", + "# verifier.verify(hash_obj, signature)\n", + "# print(\"\\nThe message is authentic.\")\n", + "# except ValueError:\n", + "# print(\"\\nThe message is not authentic.\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "2034a8fd-c89e-461f-805b-5b37c4c7d395", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/enclaves/Action-Object-Performance.ipynb b/notebooks/experimental/enclaves/Action-Object-Performance.ipynb new file mode 100644 index 00000000000..a34b2d229f1 --- /dev/null +++ b/notebooks/experimental/enclaves/Action-Object-Performance.ipynb @@ -0,0 +1,150 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "e0141faa-33db-4d35-95c1-7eaa38061223", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "61be8866-cf01-4577-bdf0-4114995eb39a", + "metadata": {}, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=8081, dev_mode=True, reset=True, profile=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "d509c48c-96a1-4706-8dbd-27143eeba41b", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client = canada_server.login(email=\"info@openmined.org\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "c6b619a7-427e-4eee-9a24-4c65dee67e6f", + "metadata": {}, + "outputs": [], + "source": [ + "data = b\"A\" * (2**28) # 1GB message" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "1e15f7e3-8f0c-4981-b9bf-9ed2ba308282", + "metadata": {}, + "outputs": [], + "source": [ + "len(data) / 2**20" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "27a9c748-2d96-4970-bc84-76077bc326a8", + "metadata": {}, + "outputs": [], + "source": [ + "%%pyinstrument\n", + "action_obj = sy.ActionObject.from_obj(data)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "ce834e46-f181-486f-bf0f-6082d7b85281", + "metadata": {}, + "outputs": [], + "source": [ + "# %%pyinstrument\n", + "# res = action_obj.send(domain_client)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "ef814db6-b86f-48d3-8b07-d99499650d05", + "metadata": {}, + "outputs": [], + "source": [ + "# res" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9dc5cb5b-0e6a-46d5-87a4-f1c0084c77bb", + "metadata": {}, + "outputs": [], + "source": [ + "# domain_client.api.services.action.get_hash(res.id)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "f7838dce-57fe-494e-942d-738f931f5697", + "metadata": {}, + "outputs": [], + "source": [ + "# %%time\n", + "# val = domain_client.api.services.action.get(res.id)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "66db2667-04f4-4b79-b5a8-f52ee0bca233", + "metadata": {}, + "outputs": [], + "source": [ + "# %%time\n", + "# _ = val.syft_action_data" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9e20b517-7ac4-4979-8198-883c03129fb0", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/enclaves/Attestation.ipynb b/notebooks/experimental/enclaves/Attestation.ipynb new file mode 100644 index 00000000000..e889e51ce22 --- /dev/null +++ b/notebooks/experimental/enclaves/Attestation.ipynb @@ -0,0 +1,179 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "8c096777-07f8-49b9-99b0-e53766dba8ef", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "from syft.service.attestation.attestation_cpu_report import CPUAttestationReport\n", + "from syft.service.attestation.attestation_gpu_report import GPUAttestationReport\n", + "from syft.service.attestation.attestation_mock_cpu_report import CPU_MOCK_REPORT\n", + "from syft.service.attestation.attestation_mock_gpu_report import GPU_MOCK_REPORT\n", + "from syft.service.attestation.utils import AttestationType\n", + "from syft.service.attestation.utils import verify_attestation_report" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "141b5813-91a5-42b8-8a44-2ba2d59c7669", + "metadata": {}, + "outputs": [], + "source": [ + "attestation_type = AttestationType(\"GPU\")" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "9e2ca30b-ef14-4de8-a524-c24f59f2fead", + "metadata": {}, + "outputs": [], + "source": [ + "if attestation_type == AttestationType.CPU:\n", + " token = CPU_MOCK_REPORT\n", + "else:\n", + " token = GPU_MOCK_REPORT" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "45a566e1-7227-4af1-8276-f49defc44c79", + "metadata": {}, + "outputs": [], + "source": [ + "report = verify_attestation_report(token, attestation_type, verify_expiration=False)" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "615bd6c4-7124-4ba8-b40e-32290538d044", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "Ok({'sub': 'NVIDIA-GPU-ATTESTATION', 'secboot': True, 'x-nvidia-gpu-manufacturer': 'NVIDIA Corporation', 'x-nvidia-attestation-type': 'GPU', 'iss': 'https://nras.attestation.nvidia.com', 'eat_nonce': '12864006842D3061C9D9AB5576651F29D7D7D309677D2DEE42D8227913351CDB', 'x-nvidia-attestation-detailed-result': {'x-nvidia-gpu-driver-rim-schema-validated': True, 'x-nvidia-gpu-vbios-rim-cert-validated': True, 'x-nvidia-gpu-attestation-report-cert-chain-validated': True, 'x-nvidia-gpu-driver-rim-schema-fetched': True, 'x-nvidia-gpu-attestation-report-parsed': True, 'x-nvidia-gpu-nonce-match': True, 'x-nvidia-gpu-vbios-rim-signature-verified': True, 'x-nvidia-gpu-driver-rim-signature-verified': True, 'x-nvidia-gpu-arch-check': True, 'x-nvidia-attestation-warning': None, 'x-nvidia-gpu-measurements-match': True, 'x-nvidia-gpu-attestation-report-signature-verified': True, 'x-nvidia-gpu-vbios-rim-schema-validated': True, 'x-nvidia-gpu-driver-rim-cert-validated': True, 'x-nvidia-gpu-vbios-rim-schema-fetched': True, 'x-nvidia-gpu-vbios-rim-measurements-available': True, 'x-nvidia-gpu-driver-rim-driver-measurements-available': True}, 'x-nvidia-ver': '1.0', 'nbf': 1723442389, 'x-nvidia-gpu-driver-version': '535.129.03', 'dbgstat': 'disabled', 'hwmodel': 'GH100 A01 GSP BROM', 'oemid': '5703', 'measres': 'comparison-successful', 'exp': 1723445989, 'iat': 1723442389, 'x-nvidia-eat-ver': 'EAT-21', 'ueid': '434765761559257705805424939254888546986931277660', 'x-nvidia-gpu-vbios-version': '96.00.88.00.11', 'jti': 'db001de6-5e2d-4fb1-b7fd-f676809b6743'})" + ] + }, + "execution_count": 5, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "report" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "4e9c5bc6-dca4-4ad3-8ba9-ded53660ef57", + "metadata": {}, + "outputs": [], + "source": [ + "assert report.is_ok()" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "8badc250-bd8f-47fb-9a4d-102cd1bc2b1b", + "metadata": {}, + "outputs": [], + "source": [ + "report = report.ok()" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "id": "7f347bd8-202f-4451-806d-53eedf2cd4a4", + "metadata": {}, + "outputs": [], + "source": [ + "if attestation_type == AttestationType.CPU:\n", + " attestation_report = CPUAttestationReport(report)\n", + "else:\n", + " attestation_report = GPUAttestationReport(report)" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "03f342fe-ba5a-42db-a18c-87df4d22f2ee", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "-----------------------------------------------------------\n", + "📝 Attestation Report Summary\n", + "-----------------------------------------------------------\n", + "Issued At: 2024-08-12 05:59:49\n", + "Valid From: 2024-08-12 05:59:49\n", + "Expiry: 2024-08-12 06:59:49 (Token expires in: Expired ❌)\n", + "\n", + "📢 Issuer Information\n", + "-----------------------------------------------------------\n", + "Issuer: https://nras.attestation.nvidia.com\n", + "Attestation Type: GPU\n", + "Device ID: 434765761559257705805424939254888546986931277660\n", + "\n", + "🔒 Security Features\n", + "-----------------------------------------------------------\n", + "Secure Boot: ✅ Enabled\n", + "Debugging: ✅ Disabled\n", + "\n", + "💻 Hardware\n", + "-----------------------------------------------------------\n", + "HW Model : GH100 A01 GSP BROM\n", + "OEM ID: 5703\n", + "Driver Version: 535.129.03\n", + "VBIOS Version: 96.00.88.00.11\n", + "\n" + ] + } + ], + "source": [ + "print(attestation_report.generate_summary())" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3c0e1ee6-8ea1-47fb-ba7b-a8309413a067", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/enclaves/Hash.ipynb b/notebooks/experimental/enclaves/Hash.ipynb new file mode 100644 index 00000000000..0a0fd636d9f --- /dev/null +++ b/notebooks/experimental/enclaves/Hash.ipynb @@ -0,0 +1,171 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "4e901f03-66aa-4ee9-8665-866a261cb298", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import numpy as np\n", + "\n", + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "1fda9bfc-c8a1-48be-9567-02b4075b13d5", + "metadata": {}, + "outputs": [], + "source": [ + "a1 = sy.ActionObject.from_obj(np.array([1, 2, 3]))" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "e0d25819-5367-4328-acd7-3bcaa8428c69", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'a9ec1f75a9003848fa9886e4cc2b7333b99d089af97ec6e0f774ba8bf92a1226'" + ] + }, + "execution_count": 3, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "a1.hash()" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "20f5fff0-846d-4df2-a3d0-cfd615693f39", + "metadata": {}, + "outputs": [], + "source": [ + "b1 = sy.ActionObject.from_obj(id=a1.id, syft_action_data=np.array([1, 2, 3]))" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "be93aaba-2d5f-46a0-9bd1-0f09b70e4c08", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'a9ec1f75a9003848fa9886e4cc2b7333b99d089af97ec6e0f774ba8bf92a1226'" + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "b1.hash()" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "008146b5-8ef2-4043-bf77-05c2c4295561", + "metadata": {}, + "outputs": [], + "source": [ + "a2 = sy.ActionObject.from_obj(5)" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "40d2c07b-458d-44ab-bbc3-c5808263df85", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'8ee92c1a13aecee2cd3c4be229b01dc87d32236163f0b57f1277fe36a9e5dba9'" + ] + }, + "execution_count": 14, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "a2.hash()" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "821afc65-db28-45b5-ba9d-52bf82c19e03", + "metadata": {}, + "outputs": [], + "source": [ + "b2 = sy.ActionObject.from_obj(id=a2.id, syft_action_data=5)" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "df7dc61b-7f7b-47da-8119-34fbd0c272dc", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'8ee92c1a13aecee2cd3c4be229b01dc87d32236163f0b57f1277fe36a9e5dba9'" + ] + }, + "execution_count": 16, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "b2.hash()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "fddfdadb-4d7c-4f24-9ff0-15c7e4f9164c", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/enclaves/V1/00-do-setup-domain.ipynb b/notebooks/experimental/enclaves/V1/00-do-setup-domain.ipynb new file mode 100644 index 00000000000..de366a74e7e --- /dev/null +++ b/notebooks/experimental/enclaves/V1/00-do-setup-domain.ipynb @@ -0,0 +1,302 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "In this tutorial, we will demonstrate how to use **Enclaves** in PySyft to securely perform computations among assets from multiple domains. We will cover the following workflows:\n", + "\n", + "Constraints:\n", + "\n", + "1. Once the enclave is set up for multiparty code execution, no domain has special privileges, and all domain are the same citizen, even the one responsible for leasing the Enclave.\n", + "2. Domains must not communicate with each other, neither should the system require domains to be aware of the presence of other domains.\n", + "3. System should be able to run the computation on both long-running Enclaves, as well as ephemeral (on-demand) Enclaves.\n", + "4. DS is assumed to have the highest interest in ensuring code execution.\n", + "5. DS is aware of all the domains and enclaves present in the network.\n", + "6. Principle of least privilege is followed.\n", + "\n", + "## Data Owners Workflow - Part 1\n", + "[./00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)\n", + "- Launch two domain servers for providing data to the data scientist.\n", + "- Launch one enclave server for performing the secure computation using data from both the domain servers.\n", + "- Upload datasets to both the domain servers.\n", + "- Register an account for the data scientist in both the domain servers.\n", + "- Register the enclave server with one of the domain servers for discoverability by the data scientist.\n", + "\n", + "## Data Scientist Workflow - Part 1\n", + "[./01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb)\n", + "- Find datasets across multiple domains.\n", + "- Find a suitable Enclave for performing the multi-party computation.\n", + "- Create a project containing code to perform multi-party computation.\n", + "- Submit the project for review by the data owners.\n", + "\n", + "## Data Owner Workflow - Part 2\n", + "[./02-do-review-code.ipynb](./02-do-review-code.ipynb)\n", + "- View all pending projects.\n", + "- Select a project and review the code, assets and the policies.\n", + "- Run the code on mock data from all the dependent domains.\n", + "- Approve the request.\n", + "\n", + "## Data Scientist Workflow - Part 2\n", + "[./03-ds-execute-code.ipynb](./03-ds-execute-code.ipynb)\n", + "- Check the project approval.\n", + "- Request execution when the code is approved and ready\n", + "- Download the result." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import pytest\n", + "from recordlinkage.datasets import load_febrl4\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "from syft.service.network.routes import HTTPServerRoute\n", + "from syft.service.response import SyftAttributeError\n", + "from syft.service.response import SyftSuccess\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082\n", + "CANADA_ENCLAVE_PORT = 9083" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Launch servers\n", + "\n", + "We will begin by launching two domain servers and an enclave server." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True, reset=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True, reset=True\n", + ")\n", + "canada_enclave = sy.orchestra.launch(\n", + " name=\"canada-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " port=CANADA_ENCLAVE_PORT,\n", + " dev_mode=True,\n", + " reset=True,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")\n", + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")\n", + "\n", + "assert do_canada_client.metadata.server_type == ServerType.DOMAIN\n", + "assert do_italy_client.metadata.server_type == ServerType.DOMAIN" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Upload datasets to both domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Using public datasets from Freely Extensible Biomedical Record Linkage (Febrl) project\n", + "canada_census_data, italy_census_data = load_febrl4()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "for dataset, client, country in zip(\n", + " [canada_census_data, italy_census_data],\n", + " [do_canada_client, do_italy_client],\n", + " [\"Canada\", \"Italy\"],\n", + "):\n", + " private_data, mock_data = dataset[:2500], dataset[2500:]\n", + " dataset = sy.Dataset(\n", + " name=f\"{country} - FEBrl Census Data\",\n", + " description=\"abc\",\n", + " asset_list=[\n", + " sy.Asset(\n", + " name=\"census_data\",\n", + " mock=mock_data,\n", + " data=private_data,\n", + " shape=private_data.shape,\n", + " mock_is_real=True,\n", + " )\n", + " ],\n", + " )\n", + " client.upload_dataset(dataset)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.datasets.get_all()) == 1\n", + "assert len(do_italy_client.datasets.get_all()) == 1" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create account for data scientist on both the domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "for client in [do_canada_client, do_italy_client]:\n", + " res = client.register(\n", + " name=\"Sheldon\",\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + " password_verify=\"changethis\",\n", + " )\n", + " assert isinstance(res, SyftSuccess)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Register the enclave with Canada domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "route = HTTPServerRoute(host_or_ip=\"localhost\", port=CANADA_ENCLAVE_PORT)\n", + "do_canada_client.enclaves.add(route=route)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert (len(do_canada_client.enclaves.get_all())) == 1\n", + "do_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = sy.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\", port=CANADA_DOMAIN_PORT\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Data scientist should not be able to add enclave to the domain\n", + "with pytest.raises(SyftAttributeError) as exc_info:\n", + " ds_canada_client.enclaves.add(\n", + " name=\"Dummy Enclave\", route=HTTPServerRoute(host_or_ip=\"localhost\", port=9084)\n", + " )\n", + "print(exc_info.value)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Ensure that the data scientist can access the enclave added by the domain owner\n", + "assert (len(ds_canada_client.enclaves.get_all())) == 1\n", + "ds_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V1/01-ds-submit-project.ipynb b/notebooks/experimental/enclaves/V1/01-ds-submit-project.ipynb new file mode 100644 index 00000000000..8ea9b677d7d --- /dev/null +++ b/notebooks/experimental/enclaves/V1/01-ds-submit-project.ipynb @@ -0,0 +1,296 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)\n", + "- Next: [02-do-review-code.ipynb](./02-do-review-code.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb) and have a DS account on both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import pytest\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "from syft.service.response import SyftAttributeError\n", + "from syft.service.response import SyftException\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Log in to the domain servers as a data scientist" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Find datasets across multiple domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_census_data = ds_canada_client.datasets[-1].assets[0]\n", + "italy_census_data = ds_italy_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Find an available enclave" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "all_enclaves = ds_canada_client.enclaves.get_all() + ds_italy_client.enclaves.get_all()\n", + "all_enclaves" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "enclave = all_enclaves[0]\n", + "enclave" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create and submit a distributed project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Code to perform the multi-party computation\n", + "\n", + "\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " canada_census_data=canada_census_data,\n", + " italy_census_data=italy_census_data,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " # image=sy.DockerWorkerConfig(dockerfile=dockerfile_str),\n", + " # workers_num=4,\n", + " # worker_pool_name=worker_pool_name,\n", + " # timeout=300,\n", + " # result_persistence={\"storage_path\": \"/data/enclave\", \"retention_policy\": \"30d\"}\n", + " ),\n", + ")\n", + "def compute_census_matches(canada_census_data, italy_census_data):\n", + " # third party\n", + " import recordlinkage\n", + "\n", + " # Index step\n", + " indexer = recordlinkage.Index()\n", + " indexer.block(\"given_name\")\n", + "\n", + " candidate_links = indexer.index(canada_census_data, italy_census_data)\n", + "\n", + " # Comparison step\n", + " compare_cl = recordlinkage.Compare()\n", + "\n", + " compare_cl.exact(\"given_name\", \"given_name\", label=\"given_name\")\n", + " compare_cl.string(\n", + " \"surname\", \"surname\", method=\"jarowinkler\", threshold=0.85, label=\"surname\"\n", + " )\n", + " compare_cl.exact(\"date_of_birth\", \"date_of_birth\", label=\"date_of_birth\")\n", + " compare_cl.exact(\"suburb\", \"suburb\", label=\"suburb\")\n", + " compare_cl.exact(\"state\", \"state\", label=\"state\")\n", + " compare_cl.string(\"address_1\", \"address_1\", threshold=0.85, label=\"address_1\")\n", + "\n", + " features = compare_cl.compute(\n", + " candidate_links, canada_census_data, italy_census_data\n", + " )\n", + "\n", + " # Classification step\n", + " matches = features[features.sum(axis=1) > 3]\n", + "\n", + " return len(matches)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "new_project = sy.DistributedProject(\n", + " name=\"Census Matching\",\n", + " description=\"Match census data between Canada and Italy\",\n", + " code=compute_census_matches,\n", + ")\n", + "new_project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Check result of execution on mock data\n", + "mock_result = compute_census_matches(\n", + " canada_census_data=canada_census_data.mock,\n", + " italy_census_data=italy_census_data.mock,\n", + ")\n", + "mock_result" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Submit the project to all the domains for approval\n", + "project = new_project.submit()\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert project.requests[0].server_uid == ds_canada_client.id\n", + "assert project.requests[1].server_uid == ds_italy_client.id" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Test: data scientist should not be able to request execution without approval of all servers\n", + "assert project.pending_requests != 0 # There are pending requests\n", + "with pytest.raises(SyftException) as exc_info:\n", + " project.request_execution(blocking=True)\n", + "print(exc_info.value)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Test: data scientist should not be able to approve the request\n", + "with pytest.raises(SyftAttributeError) as exc_info:\n", + " project.requests[0].approve()\n", + "print(exc_info.value)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "PySyft", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/notebooks/experimental/enclaves/V1/02-do-review-code.ipynb b/notebooks/experimental/enclaves/V1/02-do-review-code.ipynb new file mode 100644 index 00000000000..4dc3452f817 --- /dev/null +++ b/notebooks/experimental/enclaves/V1/02-do-review-code.ipynb @@ -0,0 +1,244 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb)\n", + "- Next: [03-ds-execute-code.ipynb](./03-ds-execute-code.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb) and have a pending project and code request from the DS in both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Log in to the first domain server as the data owner" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# View all pending project requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.projects" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Select the project you want to work with\n", + "project = do_canada_client.projects[0]\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Select a request and explore its attributes\n", + "request = project.requests[0]\n", + "request" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Review the code, dataset and policies" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# See the code written by the Data Scientist and its metadata in the request\n", + "func = request.code\n", + "func" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Find the assets required for the computation\n", + "func.assets" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Review the runtime policy\n", + "assert func.runtime_policy_type == sy.RunOnEnclave\n", + "provider = func.runtime_policy_init_kwargs[\"provider\"]\n", + "provider" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Execute the code with mock data\n", + "# TODO this should take mock data from all dependent domains and execute the function\n", + "# func.execute_with_mock_data()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Approve the request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "request.approve()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Approve the code from the other domain server" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")\n", + "\n", + "projects = do_italy_client.projects.get_all()\n", + "assert len(projects) == 1\n", + "\n", + "requests = projects[0].requests\n", + "assert len(requests) == 1\n", + "request = requests[0]\n", + "\n", + "func = request.code\n", + "# TODO change below to 2 once we start showing assets from other domains\n", + "assert len(func.assets) == 1\n", + "assert func.runtime_policy_type == sy.RunOnEnclave\n", + "\n", + "request.approve()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "PySyft", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/notebooks/experimental/enclaves/V1/03-ds-execute-code.ipynb b/notebooks/experimental/enclaves/V1/03-ds-execute-code.ipynb new file mode 100644 index 00000000000..4ab56eb29a9 --- /dev/null +++ b/notebooks/experimental/enclaves/V1/03-ds-execute-code.ipynb @@ -0,0 +1,161 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [02-do-review-code.ipynb](./02-do-review-code.ipynb)\n", + "- First: [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [02-do-review-code.ipynb](./02-do-review-code.ipynb) and the submitted code is approved by both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082\n", + "CANADA_ENCLAVE_PORT = 9083" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "canada_enclave = sy.orchestra.launch(\n", + " name=\"canada-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " port=CANADA_ENCLAVE_PORT,\n", + " dev_mode=True,\n", + " create_producer=True,\n", + " n_consumers=3,\n", + " reset=True, # * Reset the enclave each time for ease in development\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "project = sy.DistributedProject.get_by_name(\n", + " \"Census Matching\", clients=[ds_canada_client, ds_italy_client]\n", + ")\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert project.pending_requests == 0" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# TODO\n", + "# job = project.request_execution(blocking=False)\n", + "result = project.request_execution(blocking=True)\n", + "print(result)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# TODO\n", + "# result = job.wait().get()\n", + "result" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "PySyft", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/notebooks/experimental/enclaves/V2/00-do-setup-domain.ipynb b/notebooks/experimental/enclaves/V2/00-do-setup-domain.ipynb new file mode 100644 index 00000000000..fc215ade52e --- /dev/null +++ b/notebooks/experimental/enclaves/V2/00-do-setup-domain.ipynb @@ -0,0 +1,309 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "In this tutorial, we will demonstrate how to use **Enclaves** in PySyft to securely perform computations among assets from multiple domains. We will cover the following workflows:\n", + "\n", + "Constraints:\n", + "\n", + "1. Once the enclave is set up for multiparty code execution, no domain has special privileges, and all domain are the same citizen, even the one responsible for leasing the Enclave.\n", + "2. Domains must not communicate with each other, neither should the system require domains to be aware of the presence of other domains.\n", + "3. System should be able to run the computation on both long-running Enclaves, as well as ephemeral (on-demand) Enclaves.\n", + "4. DS is assumed to have the highest interest in ensuring code execution.\n", + "5. DS is aware of all the domains and enclaves present in the network.\n", + "6. Principle of least privilege is followed.\n", + "\n", + "## Data Owners Workflow - Part 1\n", + "[./00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)\n", + "- Launch two domain servers for providing data to the data scientist.\n", + "- Launch one enclave server for performing the secure computation using data from both the domain servers.\n", + "- Upload datasets to both the domain servers.\n", + "- Register an account for the data scientist in both the domain servers.\n", + "- Register the enclave server with one of the domain servers for discoverability by the data scientist.\n", + "\n", + "## Data Scientist Workflow - Part 1\n", + "[./01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb)\n", + "- Find datasets across multiple domains.\n", + "- Find a suitable Enclave for performing the multi-party computation.\n", + "- Create a project containing code to perform multi-party computation.\n", + "- Submit the project for review by the data owners.\n", + "\n", + "## Data Owner Workflow - Part 2\n", + "[./02-do-review-code.ipynb](./02-do-review-code.ipynb)\n", + "- View all pending projects.\n", + "- Select a project and review the code, assets and the policies.\n", + "- Run the code on mock data from all the dependent domains.\n", + "- Approve the request.\n", + "\n", + "## Data Scientist Workflow - Part 2\n", + "[./03-ds-execute-code.ipynb](./03-ds-execute-code.ipynb)\n", + "- Check the project approval.\n", + "- Request execution when the code is approved and ready\n", + "- Download the result." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import pytest\n", + "from recordlinkage.datasets import load_febrl4\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "from syft.service.network.routes import HTTPServerRoute\n", + "from syft.service.response import SyftAttributeError\n", + "from syft.service.response import SyftSuccess\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082\n", + "CANADA_ENCLAVE_PORT = 9083" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Launch servers\n", + "\n", + "We will begin by launching two domain servers and an enclave server." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True, reset=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True, reset=True\n", + ")\n", + "canada_enclave = sy.orchestra.launch(\n", + " name=\"canada-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " port=CANADA_ENCLAVE_PORT,\n", + " dev_mode=True,\n", + " reset=True,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")\n", + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")\n", + "\n", + "assert do_canada_client.metadata.server_type == ServerType.DOMAIN\n", + "assert do_italy_client.metadata.server_type == ServerType.DOMAIN" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Upload datasets to both domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Using public datasets from Freely Extensible Biomedical Record Linkage (Febrl) project\n", + "canada_census_data, italy_census_data = load_febrl4()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "for dataset, client, country in zip(\n", + " [canada_census_data, italy_census_data],\n", + " [do_canada_client, do_italy_client],\n", + " [\"Canada\", \"Italy\"],\n", + "):\n", + " private_data, mock_data = dataset[:2500], dataset[2500:]\n", + " dataset = sy.Dataset(\n", + " name=f\"{country} - FEBrl Census Data\",\n", + " description=\"abc\",\n", + " asset_list=[\n", + " sy.Asset(\n", + " name=\"census_data\",\n", + " mock=mock_data,\n", + " data=private_data,\n", + " shape=private_data.shape,\n", + " mock_is_real=True,\n", + " )\n", + " ],\n", + " )\n", + " client.upload_dataset(dataset)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.datasets.get_all()) == 1\n", + "assert len(do_italy_client.datasets.get_all()) == 1" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create account for data scientist on both the domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "for client in [do_canada_client, do_italy_client]:\n", + " res = client.register(\n", + " name=\"Sheldon\",\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + " password_verify=\"changethis\",\n", + " )\n", + " assert isinstance(res, SyftSuccess)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Register the enclave with Canada domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "route = HTTPServerRoute(host_or_ip=\"localhost\", port=CANADA_ENCLAVE_PORT)\n", + "do_canada_client.enclaves.add(route=route)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert (len(do_canada_client.enclaves.get_all())) == 1\n", + "do_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = sy.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\", port=CANADA_DOMAIN_PORT\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Data scientist should not be able to add enclave to the domain\n", + "with pytest.raises(SyftAttributeError) as exc_info:\n", + " ds_canada_client.enclaves.add(\n", + " name=\"Dummy Enclave\", route=HTTPServerRoute(host_or_ip=\"localhost\", port=9084)\n", + " )\n", + "print(exc_info.value)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Ensure that the data scientist can access the enclave added by the domain owner\n", + "assert (len(ds_canada_client.enclaves.get_all())) == 1\n", + "ds_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V2/01-connect-domains.ipynb b/notebooks/experimental/enclaves/V2/01-connect-domains.ipynb new file mode 100644 index 00000000000..656c2abc900 --- /dev/null +++ b/notebooks/experimental/enclaves/V2/01-connect-domains.ipynb @@ -0,0 +1,271 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "1. In the Previous project object, DS was able to easily associate domains, as we did not have association\n", + "requests.This would mean that the DS needs to submit assocation requests to domains to connect them with each other.\n", + "\n", + "2. Project Invitation is a useful feature, but is very hard to implement, when in a distrubted setting, let us assume the DS is able to create projects on domains without any request/approval on the Project Itself.\n", + "\n", + "3. The Data Scientist is able to create a project if and only if , all the domains could talk to each other. (i.e they have beeen previously associated)\n", + "\n", + "4. This would mean that in our semi-Decentralized, leader based system , when ever a server would like to add an event/message to the project, it has to be sent to the leader, which is then broadcasted to all the other servers.\n", + "\n", + "5. For other situations, for example when a server would like to asset metadata of another server in a Multi Domain User Code request, they could directly contact the server, to retrieve the info, instead of going through the leader.\n", + "\n", + "6. This would require us to create a Full Mesh Network Topology, where each server is connected to each other." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "from syft.service.network.server_peer import ServerPeer\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Launch servers\n", + "\n", + "We will begin by launching two domain servers and an enclave server." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\",\n", + " port=CANADA_DOMAIN_PORT,\n", + " dev_mode=True,\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\",\n", + " port=ITALY_DOMAIN_PORT,\n", + " dev_mode=True,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")\n", + "\n", + "assert ds_canada_client.metadata.server_type == ServerType.DOMAIN\n", + "assert ds_italy_client.metadata.server_type == ServerType.DOMAIN" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create Assocation Requests from DS" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_server_peer = ServerPeer.from_client(ds_canada_client)\n", + "canada_server_peer" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_server_peer = ServerPeer.from_client(ds_italy_client)\n", + "italy_server_peer" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_conn_req = ds_canada_client.api.services.network.add_peer(italy_server_peer)\n", + "canada_conn_req" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_conn_req = ds_italy_client.api.services.network.add_peer(canada_server_peer)\n", + "italy_conn_req" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Data Owners Login and Approve the Association Requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")\n", + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert do_canada_client.peers[0].id == do_italy_client.id\n", + "do_canada_client.peers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_italy_client.api.services.request.get_all()) == 1\n", + "do_italy_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert do_italy_client.peers[0].id == do_canada_client.id\n", + "do_italy_client.peers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "from syft.service.network.utils import check_route_reachability" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "check_route_reachability([ds_canada_client, ds_italy_client])" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V2/02-ds-submit-project.ipynb b/notebooks/experimental/enclaves/V2/02-ds-submit-project.ipynb new file mode 100644 index 00000000000..105b26d2ade --- /dev/null +++ b/notebooks/experimental/enclaves/V2/02-ds-submit-project.ipynb @@ -0,0 +1,293 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)\n", + "- Next: [02-do-review-code.ipynb](./02-do-review-code.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb) and have a DS account on both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Log in to the domain servers as a data scientist" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Find datasets across multiple domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_census_data = ds_canada_client.datasets[-1].assets[0]\n", + "italy_census_data = ds_italy_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Find an available enclave" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "all_enclaves = ds_canada_client.enclaves.get_all() + ds_italy_client.enclaves.get_all()\n", + "all_enclaves" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "enclave = all_enclaves[0]\n", + "enclave" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create and submit a distributed project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Code to perform the multi-party computation\n", + "\n", + "\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " canada_census_data=canada_census_data,\n", + " italy_census_data=italy_census_data,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " # image=sy.DockerWorkerConfig(dockerfile=dockerfile_str),\n", + " # workers_num=4,\n", + " # worker_pool_name=worker_pool_name,\n", + " # timeout=300,\n", + " # result_persistence={\"storage_path\": \"/data/enclave\", \"retention_policy\": \"30d\"}\n", + " ),\n", + ")\n", + "def compute_census_matches(canada_census_data, italy_census_data):\n", + " # third party\n", + " import recordlinkage\n", + "\n", + " # Index step\n", + " indexer = recordlinkage.Index()\n", + " indexer.block(\"given_name\")\n", + "\n", + " candidate_links = indexer.index(canada_census_data, italy_census_data)\n", + "\n", + " # Comparison step\n", + " compare_cl = recordlinkage.Compare()\n", + "\n", + " compare_cl.exact(\"given_name\", \"given_name\", label=\"given_name\")\n", + " compare_cl.string(\n", + " \"surname\", \"surname\", method=\"jarowinkler\", threshold=0.85, label=\"surname\"\n", + " )\n", + " compare_cl.exact(\"date_of_birth\", \"date_of_birth\", label=\"date_of_birth\")\n", + " compare_cl.exact(\"suburb\", \"suburb\", label=\"suburb\")\n", + " compare_cl.exact(\"state\", \"state\", label=\"state\")\n", + " compare_cl.string(\"address_1\", \"address_1\", threshold=0.85, label=\"address_1\")\n", + "\n", + " features = compare_cl.compute(\n", + " candidate_links, canada_census_data, italy_census_data\n", + " )\n", + "\n", + " # Classification step\n", + " matches = features[features.sum(axis=1) > 3]\n", + "\n", + " return len(matches)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Check result of execution on mock data\n", + "mock_result = compute_census_matches(\n", + " canada_census_data=canada_census_data.mock,\n", + " italy_census_data=italy_census_data.mock,\n", + ")\n", + "mock_result" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "new_project = sy.Project(\n", + " name=\"Census Matching\",\n", + " description=\"Match census data between Canada and Italy\",\n", + " members=[ds_canada_client, ds_italy_client],\n", + ")\n", + "new_project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "project = new_project.send()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "project.create_code_request(\n", + " compute_census_matches, clients=[ds_canada_client, ds_italy_client]\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# TODO: Should the Data Scientist see all the requests intially when the object is not retrieved from a domain\n", + "assert len(project.requests) == 0" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V2/03-do-review-code.ipynb b/notebooks/experimental/enclaves/V2/03-do-review-code.ipynb new file mode 100644 index 00000000000..9b4a5dfd1d3 --- /dev/null +++ b/notebooks/experimental/enclaves/V2/03-do-review-code.ipynb @@ -0,0 +1,367 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb)\n", + "- Next: [03-ds-execute-code.ipynb](./03-ds-execute-code.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [01-ds-submit-project.ipynb](./01-ds-submit-project.ipynb) and have a pending project and code request from the DS in both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Launch Domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Log in to the first domain server as the data owner" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# View all pending project requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.projects" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Select the project you want to work with\n", + "canada_project = do_canada_client.projects[0]\n", + "canada_project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Select a request and explore its attributes\n", + "request = canada_project.requests[0]\n", + "request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.code[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.code[0].status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Review the code, dataset and policies" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# See the code written by the Data Scientist and its metadata in the request\n", + "func = request.code\n", + "func" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Find the assets required for the computation\n", + "func.assets" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Review the runtime policy\n", + "assert func.runtime_policy_type == sy.RunOnEnclave\n", + "deployment_provider = func.runtime_policy_init_kwargs[\"provider\"]\n", + "deployment_provider" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Execute the code with mock data\n", + "# TODO this should take mock data from all dependent domains and execute the function\n", + "# func.execute_with_mock_data()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Approve the request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "request.approve()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Check Project Status" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.sync()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.code[0].status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Approve the code from the other domain server" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_project = do_italy_client.projects[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_project.code[0].status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "requests = italy_project.requests\n", + "assert len(requests) == 1\n", + "request = requests[0]\n", + "\n", + "func = request.code\n", + "# TODO change below to 2 once we start showing assets from other domains\n", + "assert len(func.assets) == 1\n", + "assert func.runtime_policy_type == sy.RunOnEnclave\n", + "\n", + "request.approve()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Get Code Status on Project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_project.sync()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "italy_project.code[0].status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.sync()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "canada_project.code[0].status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V2/04-ds-execute-code.ipynb b/notebooks/experimental/enclaves/V2/04-ds-execute-code.ipynb new file mode 100644 index 00000000000..a16665b9cf7 --- /dev/null +++ b/notebooks/experimental/enclaves/V2/04-ds-execute-code.ipynb @@ -0,0 +1,193 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Introduction\n", + "\n", + "- Previous: [02-do-review-code.ipynb](./02-do-review-code.ipynb)\n", + "- First: [00-do-setup-domain.ipynb](./00-do-setup-domain.ipynb)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Prerequisites\n", + "You have ran the [02-do-review-code.ipynb](./02-do-review-code.ipynb) and the submitted code is approved by both `canada-domain` and `italy-domain`." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "\n", + "CANADA_DOMAIN_PORT = 9081\n", + "ITALY_DOMAIN_PORT = 9082\n", + "CANADA_ENCLAVE_PORT = 9083" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=CANADA_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-domain\", port=ITALY_DOMAIN_PORT, dev_mode=True\n", + ")\n", + "canada_enclave = sy.orchestra.launch(\n", + " name=\"canada-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " port=CANADA_ENCLAVE_PORT,\n", + " dev_mode=True,\n", + " create_producer=True,\n", + " n_consumers=3,\n", + " reset=True, # * Reset the enclave each time for ease in development\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "project = ds_canada_client.api.services.project.get_by_name(\"Census Matching\")\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "assert project.pending_requests == 0" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "code = project.code[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "code.setup_enclave()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "code.request_asset_transfer()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "code.request_execution()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "result = code.get_result()\n", + "print(result)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Or you can call all of the above in one line using the following\n", + "result = code.orchestrate_enclave_execution()\n", + "print(result)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/notebooks/experimental/enclaves/V2/V2-Enclave-Single-Notebook.ipynb b/notebooks/experimental/enclaves/V2/V2-Enclave-Single-Notebook.ipynb new file mode 100644 index 00000000000..1244ecdcb16 --- /dev/null +++ b/notebooks/experimental/enclaves/V2/V2-Enclave-Single-Notebook.ipynb @@ -0,0 +1,700 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "0", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "from recordlinkage.datasets import load_febrl4\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "from syft.service.code.user_code import UserCodeStatus\n", + "from syft.service.network.routes import HTTPServerRoute\n", + "from syft.service.network.server_peer import ServerPeer\n", + "from syft.service.network.utils import check_route_reachability\n", + "from syft.service.project.project import ProjectCode\n", + "from syft.service.response import SyftSuccess\n", + "from syft.types.uid import UID\n", + "\n", + "CANADA_DATASITE_PORT = 9081\n", + "ITALY_DATASITE_PORT = 9082\n", + "CANADA_ENCLAVE_HOST = None\n", + "CANADA_ENCLAVE_PORT = 9083\n", + "\n", + "CPU_ENCLAVE = \"13.90.101.161\"\n", + "GPU_ENCLAVE = \"172.176.204.136\"\n", + "#! Uncomment below line to run the code on a pre-provisioned remote Enclave\n", + "CANADA_ENCLAVE_HOST = None" + ] + }, + { + "cell_type": "markdown", + "id": "1", + "metadata": {}, + "source": [ + "# Launch servers\n", + "\n", + "We will begin by launching two datasite servers and an enclave server." + ] + }, + { + "cell_type": "markdown", + "id": "2", + "metadata": {}, + "source": [ + "### For Kubernetes\n", + "To run the servers in kubernetes, run the below commands and wait till the cluster becomes ready.\n", + "```bash\n", + "CLUSTER_NAME=canada-datasite CLUSTER_HTTP_PORT=9081 tox -e dev.k8s.launch.datasite\n", + "CLUSTER_NAME=italy-datasite CLUSTER_HTTP_PORT=9082 tox -e dev.k8s.launch.datasite\n", + "CLUSTER_NAME=canada-enclave CLUSTER_HTTP_PORT=9083 tox -e dev.k8s.launch.enclave\n", + "```" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3", + "metadata": {}, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-datasite\", port=CANADA_DATASITE_PORT, dev_mode=True, reset=True\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-datasite\", port=ITALY_DATASITE_PORT, dev_mode=True, reset=True\n", + ")\n", + "enclave_kwargs = {\n", + " \"name\": \"canada-enclave\",\n", + " \"server_type\": ServerType.ENCLAVE,\n", + " \"port\": CANADA_ENCLAVE_PORT,\n", + " \"create_producer\": True,\n", + " \"n_consumers\": 3,\n", + " \"dev_mode\": True,\n", + " \"reset\": True,\n", + "}\n", + "if CANADA_ENCLAVE_HOST:\n", + " enclave_kwargs.update({\"deploy_to\": \"remote\", \"host\": CANADA_ENCLAVE_HOST})\n", + "\n", + "canada_enclave = sy.orchestra.launch(**enclave_kwargs)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=\"changethis\"\n", + ")\n", + "do_italy_client = italy_server.login(email=\"info@openmined.org\", password=\"changethis\")\n", + "\n", + "assert do_canada_client.metadata.server_type == ServerType.DATASITE\n", + "assert do_italy_client.metadata.server_type == ServerType.DATASITE" + ] + }, + { + "cell_type": "markdown", + "id": "5", + "metadata": {}, + "source": [ + "# Upload datasets to both datasites" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6", + "metadata": {}, + "outputs": [], + "source": [ + "# Using public datasets from Freely Extensible Biomedical Record Linkage (Febrl) project\n", + "canada_census_data, italy_census_data = load_febrl4()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "7", + "metadata": {}, + "outputs": [], + "source": [ + "for dataset, client, country in zip(\n", + " [canada_census_data, italy_census_data],\n", + " [do_canada_client, do_italy_client],\n", + " [\"Canada\", \"Italy\"],\n", + "):\n", + " private_data, mock_data = dataset[:2500], dataset[2500:]\n", + " dataset = sy.Dataset(\n", + " name=f\"{country} - FEBrl Census Data\",\n", + " description=\"abc\",\n", + " asset_list=[\n", + " sy.Asset(\n", + " name=\"census_data\",\n", + " mock=mock_data,\n", + " data=private_data,\n", + " shape=private_data.shape,\n", + " mock_is_real=True,\n", + " )\n", + " ],\n", + " )\n", + " client.upload_dataset(dataset)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "8", + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.datasets.get_all()) == 1\n", + "assert len(do_italy_client.datasets.get_all()) == 1" + ] + }, + { + "cell_type": "markdown", + "id": "9", + "metadata": {}, + "source": [ + "# Create account for data scientist on both the datasites" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "10", + "metadata": {}, + "outputs": [], + "source": [ + "for client in [do_canada_client, do_italy_client]:\n", + " res = client.register(\n", + " name=\"Sheldon\",\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + " password_verify=\"changethis\",\n", + " )\n", + " assert isinstance(res, SyftSuccess)" + ] + }, + { + "cell_type": "markdown", + "id": "11", + "metadata": {}, + "source": [ + "# Register the enclave with Canada datasite" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "12", + "metadata": {}, + "outputs": [], + "source": [ + "route = HTTPServerRoute(host_or_ip=canada_enclave.url, port=canada_enclave.port)\n", + "do_canada_client.enclaves.add(route=route)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "13", + "metadata": {}, + "outputs": [], + "source": [ + "assert (len(do_canada_client.enclaves.get_all())) == 1\n", + "do_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "markdown", + "id": "14", + "metadata": {}, + "source": [ + "## Login to DS Accounts" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "15", + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "markdown", + "id": "16", + "metadata": {}, + "source": [ + "## Create Association Requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "17", + "metadata": {}, + "outputs": [], + "source": [ + "canada_server_peer = ServerPeer.from_client(ds_canada_client)\n", + "canada_server_peer" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "18", + "metadata": {}, + "outputs": [], + "source": [ + "italy_server_peer = ServerPeer.from_client(ds_italy_client)\n", + "italy_server_peer" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "19", + "metadata": {}, + "outputs": [], + "source": [ + "canada_conn_req = ds_canada_client.api.services.network.add_peer(italy_server_peer)\n", + "canada_conn_req" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "20", + "metadata": {}, + "outputs": [], + "source": [ + "italy_conn_req = ds_italy_client.api.services.network.add_peer(canada_server_peer)\n", + "italy_conn_req" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "21", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.requests[-1].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "22", + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client.requests[-1].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "23", + "metadata": {}, + "outputs": [], + "source": [ + "check_route_reachability([ds_canada_client, ds_italy_client])" + ] + }, + { + "cell_type": "markdown", + "id": "24", + "metadata": {}, + "source": [ + "# Find datasets across multiple datasites" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "25", + "metadata": {}, + "outputs": [], + "source": [ + "canada_census_data = ds_canada_client.datasets[-1].assets[0]\n", + "italy_census_data = ds_italy_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "26", + "metadata": {}, + "outputs": [], + "source": [ + "# find available enclaves\n", + "all_enclaves = ds_canada_client.enclaves.get_all() + ds_italy_client.enclaves.get_all()\n", + "all_enclaves" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "27", + "metadata": {}, + "outputs": [], + "source": [ + "enclave = all_enclaves[0]\n", + "enclave" + ] + }, + { + "cell_type": "markdown", + "id": "28", + "metadata": {}, + "source": [ + "# Create and submit a distributed project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "29", + "metadata": {}, + "outputs": [], + "source": [ + "# Code to perform the multi-party computation\n", + "\n", + "\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " canada_census_data=canada_census_data,\n", + " italy_census_data=italy_census_data,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " # image=sy.DockerWorkerConfig(dockerfile=dockerfile_str),\n", + " # workers_num=4,\n", + " # worker_pool_name=worker_pool_name,\n", + " # timeout=300,\n", + " # result_persistence={\"storage_path\": \"/data/enclave\", \"retention_policy\": \"30d\"}\n", + " ),\n", + ")\n", + "def compute_census_matches(canada_census_data, italy_census_data):\n", + " # third party\n", + " import recordlinkage\n", + "\n", + " # Index step\n", + " indexer = recordlinkage.Index()\n", + " indexer.block(\"given_name\")\n", + "\n", + " candidate_links = indexer.index(canada_census_data, italy_census_data)\n", + "\n", + " # Comparison step\n", + " compare_cl = recordlinkage.Compare()\n", + "\n", + " compare_cl.exact(\"given_name\", \"given_name\", label=\"given_name\")\n", + " compare_cl.string(\n", + " \"surname\", \"surname\", method=\"jarowinkler\", threshold=0.85, label=\"surname\"\n", + " )\n", + " compare_cl.exact(\"date_of_birth\", \"date_of_birth\", label=\"date_of_birth\")\n", + " compare_cl.exact(\"suburb\", \"suburb\", label=\"suburb\")\n", + " compare_cl.exact(\"state\", \"state\", label=\"state\")\n", + " compare_cl.string(\"address_1\", \"address_1\", threshold=0.85, label=\"address_1\")\n", + "\n", + " features = compare_cl.compute(\n", + " candidate_links, canada_census_data, italy_census_data\n", + " )\n", + "\n", + " # Classification step\n", + " matches = features[features.sum(axis=1) > 3]\n", + "\n", + " return len(matches)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "30", + "metadata": {}, + "outputs": [], + "source": [ + "# Check result of execution on mock data\n", + "mock_result = compute_census_matches(\n", + " canada_census_data=canada_census_data.mock,\n", + " italy_census_data=italy_census_data.mock,\n", + ")\n", + "mock_result" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "31", + "metadata": {}, + "outputs": [], + "source": [ + "new_project = sy.Project(\n", + " name=\"Census Matching\",\n", + " description=\"Match census data between Canada and Italy\",\n", + " members=[ds_canada_client, ds_italy_client],\n", + ")\n", + "new_project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "32", + "metadata": {}, + "outputs": [], + "source": [ + "project = new_project.send()\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "33", + "metadata": {}, + "outputs": [], + "source": [ + "project.create_code_request(\n", + " compute_census_matches, clients=[ds_canada_client, ds_italy_client]\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "34", + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.code.get_all()) == 1\n", + "assert len(do_italy_client.code.get_all()) == 1" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "35", + "metadata": {}, + "outputs": [], + "source": [ + "canada_project = do_canada_client.projects[0]\n", + "canada_code_event = canada_project.events[0]\n", + "assert isinstance(canada_code_event, ProjectCode)\n", + "canada_code_event.status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "36", + "metadata": {}, + "outputs": [], + "source": [ + "canada_code_request = [\n", + " r for r in do_canada_client.requests if isinstance(r.code_id, UID)\n", + "][-1]\n", + "assert canada_code_request.code_id == compute_census_matches.id\n", + "canada_code_request.approve()\n", + "canada_project.sync()\n", + "canada_code_event.status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "37", + "metadata": {}, + "outputs": [], + "source": [ + "italy_project = do_italy_client.projects[0]\n", + "italy_code_event = italy_project.events[0]\n", + "assert isinstance(italy_code_event, ProjectCode)\n", + "italy_code_event.status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "38", + "metadata": {}, + "outputs": [], + "source": [ + "italy_code_request = [\n", + " r for r in do_italy_client.requests if isinstance(r.code_id, UID)\n", + "][-1]\n", + "assert italy_code_request.code.id == compute_census_matches.id\n", + "italy_code_request.approve()\n", + "italy_project.sync()\n", + "italy_code_event.status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "39", + "metadata": {}, + "outputs": [], + "source": [ + "canada_project = do_canada_client.projects[0]\n", + "italy_project = do_italy_client.projects[0]\n", + "assert canada_project.id == italy_project.id" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "40", + "metadata": {}, + "outputs": [], + "source": [ + "assert canada_project.events[0].status(canada_project) == UserCodeStatus.APPROVED\n", + "assert italy_project.events[0].status(italy_project) == UserCodeStatus.APPROVED" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "41", + "metadata": {}, + "outputs": [], + "source": [ + "code = project.code[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "42", + "metadata": {}, + "outputs": [], + "source": [ + "code.setup_enclave()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "43", + "metadata": {}, + "outputs": [], + "source": [ + "code.view_attestation_report(attestation_type=\"CPU\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "44", + "metadata": {}, + "outputs": [], + "source": [ + "code.request_asset_transfer()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "45", + "metadata": {}, + "outputs": [], + "source": [ + "code.request_execution()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "46", + "metadata": {}, + "outputs": [], + "source": [ + "result = code.get_result()\n", + "print(result)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "47", + "metadata": {}, + "outputs": [], + "source": [ + "# Or you can call all of the above in one line using the following\n", + "result = code.orchestrate_enclave_execution()\n", + "print(result)" + ] + }, + { + "cell_type": "markdown", + "id": "48", + "metadata": {}, + "source": [ + "# Cleanup local datasite servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "49", + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "0b8747c8-5e4c-4115-aa8f-74c8a14c4461", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.7" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/enclaves/V3/V3-Enclave-Model-HostingSingle-Notebook.ipynb b/notebooks/experimental/enclaves/V3/V3-Enclave-Model-HostingSingle-Notebook.ipynb new file mode 100644 index 00000000000..23e24de81dc --- /dev/null +++ b/notebooks/experimental/enclaves/V3/V3-Enclave-Model-HostingSingle-Notebook.ipynb @@ -0,0 +1,1185 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "c42f9351-1ed8-4b71-9625-1ea8b9db6ee6", + "metadata": {}, + "outputs": [], + "source": [ + "# pip install transformers==4.41.2 torch==2.3.1" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "0", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "from syft.abstract_server import ServerType\n", + "from syft.service.code.user_code import UserCodeStatus\n", + "from syft.service.project.project import ProjectCode\n", + "from syft.service.response import SyftSuccess\n", + "from syft.types.uid import UID" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "a59a76cd-f307-4e53-9b09-1c6898dcb7fb", + "metadata": {}, + "outputs": [], + "source": [ + "# This noteboooks works with\n", + "# 1. in-memory workers\n", + "# 2. Local Kubernetes Clusters\n", + "# 3. Remote Kubernetes Cluster\n", + "\n", + "# *_DEPLOY_TO = \n", + "# value can be python or remote\n", + "\n", + "GLOBAL_DEPLOY_TO = \"python\" # Set this is to \"remote\" for kubernetes testing\n", + "\n", + "# CANADA_DEPLOYMENT_SETTINGS - Datasite\n", + "CANADA_DATASITE_DEPLOY_TO = GLOBAL_DEPLOY_TO\n", + "CANADA_DATASITE_HOST = \"localhost\"\n", + "CANADA_DATASITE_PORT = 9081\n", + "CANADA_DATASITE_PASSWORD = \"changethis\"\n", + "\n", + "# ITALY_DEPLOYMENT_SETTINGS - Datasite\n", + "ITALY_DATASITE_DEPLOY_TO = GLOBAL_DEPLOY_TO\n", + "ITALY_DATASITE_HOST = \"localhost\"\n", + "ITALY_DATASITE_PORT = 9082\n", + "ITALY_DATASITE_PASSWORD = \"changethis\"\n", + "\n", + "# CANADA_DEPLOYMENT_SETTINGS - Enclave\n", + "CANADA_ENCLAVE_DEPLOY_TO = GLOBAL_DEPLOY_TO\n", + "CANADA_ENCLAVE_HOST = \"localhost\"\n", + "CANADA_ENCLAVE_PORT = 9083" + ] + }, + { + "cell_type": "markdown", + "id": "1", + "metadata": {}, + "source": [ + "# Launch servers\n", + "\n", + "We will begin by launching two domain servers and an enclave server." + ] + }, + { + "cell_type": "markdown", + "id": "2", + "metadata": {}, + "source": [ + "### For Kubernetes\n", + "To run the servers in kubernetes, run the below commands and wait till the cluster becomes ready.\n", + "```bash\n", + "CLUSTER_NAME=canada-server CLUSTER_HTTP_PORT=9081 tox -e dev.k8s.launch.datasite\n", + "CLUSTER_NAME=italy-server CLUSTER_HTTP_PORT=9082 tox -e dev.k8s.launch.datasite\n", + "CLUSTER_NAME=canada-enclave CLUSTER_HTTP_PORT=9083 tox -e dev.k8s.launch.enclave\n", + "```\n", + "\n", + "To reset the servers invoke this at the root of the pysyft directory\n", + "\n", + "This is also be done in parallel shells for faster reset\n", + "```bash\n", + "./scripts/reset_k8s.sh k3d-canada-server syft\n", + "./scripts/reset_k8s.sh k3d-italy-server syft\n", + "./scripts/reset_k8s.sh k3d-canada-enclave syft\n", + "```" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3", + "metadata": { + "scrolled": true + }, + "outputs": [], + "source": [ + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-datasite\",\n", + " dev_mode=True,\n", + " reset=True,\n", + " deploy_to=CANADA_DATASITE_DEPLOY_TO,\n", + " host=CANADA_DATASITE_HOST,\n", + " port=CANADA_DATASITE_PORT,\n", + ")\n", + "italy_server = sy.orchestra.launch(\n", + " name=\"italy-datasite\",\n", + " dev_mode=True,\n", + " reset=True,\n", + " deploy_to=ITALY_DATASITE_DEPLOY_TO,\n", + " host=ITALY_DATASITE_HOST,\n", + " port=ITALY_DATASITE_PORT,\n", + ")\n", + "\n", + "canada_enclave = sy.orchestra.launch(\n", + " name=\"canada-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " dev_mode=True,\n", + " reset=True,\n", + " create_producer=True,\n", + " n_consumers=3,\n", + " deploy_to=CANADA_ENCLAVE_DEPLOY_TO,\n", + " host=CANADA_ENCLAVE_HOST,\n", + " port=CANADA_ENCLAVE_PORT,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client = canada_server.login(\n", + " email=\"info@openmined.org\", password=CANADA_DATASITE_PASSWORD\n", + ")\n", + "do_italy_client = italy_server.login(\n", + " email=\"info@openmined.org\", password=ITALY_DATASITE_PASSWORD\n", + ")\n", + "\n", + "assert do_canada_client.metadata.server_type == ServerType.DATASITE\n", + "assert do_italy_client.metadata.server_type == ServerType.DATASITE" + ] + }, + { + "cell_type": "markdown", + "id": "5", + "metadata": {}, + "source": [ + "# Upload Model to Canada Domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6", + "metadata": {}, + "outputs": [], + "source": [ + "# @sy.syft_model(name=\"gpt2\")\n", + "# class GPT2Model(sy.SyftModelClass):\n", + "# def __user_init__(self, assets: list) -> None:\n", + "# model_folder = assets[0].model_folder\n", + "\n", + "# # third party\n", + "# from transformers import AutoModelForCausalLM\n", + "# from transformers import AutoTokenizer\n", + "\n", + "# self.model = AutoModelForCausalLM.from_pretrained(model_folder)\n", + "# self.tokenizer = AutoTokenizer.from_pretrained(model_folder)\n", + "# self.pad_token_id = (\n", + "# self.tokenizer.pad_token_id\n", + "# if self.tokenizer.pad_token_id\n", + "# else self.tokenizer.eos_token_id\n", + "# )\n", + "\n", + "# def inference(self, prompt: str, raw=False, **kwargs) -> str:\n", + "# input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\n", + "# gen_tokens = self.model.generate(\n", + "# input_ids,\n", + "# do_sample=True,\n", + "# temperature=0.9,\n", + "# max_length=100,\n", + "# pad_token_id=self.pad_token_id,\n", + "# **kwargs,\n", + "# )\n", + "# if raw:\n", + "# return gen_tokens\n", + "# else:\n", + "# gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\n", + "# return gen_text\n", + "\n", + "# def inference_dump(self, prompt: str):\n", + "# encoded_input = self.tokenizer(prompt, return_tensors=\"pt\")\n", + "# return self.model(**encoded_input)" + ] + }, + { + "cell_type": "markdown", + "id": "c35ba14b-34e7-40a7-8b6e-308a1e7c3750", + "metadata": {}, + "source": [ + "## Download Model weights" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "53810d2b-785b-41f4-b5a7-c91687cd8c93", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "from huggingface_hub import snapshot_download\n", + "\n", + "MODEL_DIR = \"./gpt2\"\n", + "\n", + "snapshot_download(\n", + " repo_id=\"openai-community/gpt2\",\n", + " ignore_patterns=[\n", + " \"*.tflite\",\n", + " \"*.msgpack\",\n", + " \"*.bin\",\n", + " \"*.ot\",\n", + " \"*.h5\",\n", + " \"onnx/*\",\n", + " ],\n", + " local_dir=MODEL_DIR,\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "bd230cc1-ddc1-455c-bb0e-9c63f09b316b", + "metadata": {}, + "source": [ + "## Generate Mock Model weights" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "61519eb9-9800-470d-9b39-36b1053a5e19", + "metadata": {}, + "outputs": [], + "source": [ + "# Generate Mock Model Weights\n", + "# Comment this out, when using autogenerate_mock=True\n", + "MOCK_MODEL_DIR = \"./gpt2_mock\"\n", + "\n", + "# third party\n", + "from transformers import AutoModelForCausalLM\n", + "from transformers import AutoTokenizer\n", + "\n", + "private_model = AutoModelForCausalLM.from_pretrained(MODEL_DIR)\n", + "private_model_tokenizer = AutoTokenizer.from_pretrained(MODEL_DIR)\n", + "mock_model = AutoModelForCausalLM.from_config(private_model.config_class())\n", + "mock_model.save_pretrained(MOCK_MODEL_DIR)\n", + "private_model_tokenizer.save_pretrained(MOCK_MODEL_DIR)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "7", + "metadata": {}, + "outputs": [], + "source": [ + "model_card = \"\"\"\n", + "# GPT-2\n", + "\n", + "Test the whole generation capabilities here: https://transformer.huggingface.co/doc/gpt2-large\n", + "\n", + "Pretrained model on English language using a causal language modeling (CLM) objective. It was introduced in\n", + "[this paper](https://d4mucfpksywv.cloudfront.net/better-language-models/language_models_are_unsupervised_multitask_learners.pdf)\n", + "and first released at [this page](https://openai.com/blog/better-language-models/).\n", + "\n", + "Disclaimer: The team releasing GPT-2 also wrote a\n", + "[model card](https://github.com/openai/gpt-2/blob/master/model_card.md) for their model. Content from this model card\n", + "has been written by the Hugging Face team to complete the information they provided and give specific examples of bias.\n", + "\n", + "## Model description\n", + "\n", + "GPT-2 is a transformers model pretrained on a very large corpus of English data in a self-supervised fashion. This\n", + "means it was pretrained on the raw texts only, with no humans labelling them in any way (which is why it can use lots\n", + "of publicly available data) with an automatic process to generate inputs and labels from those texts. More precisely,\n", + "it was trained to guess the next word in sentences.\n", + "\n", + "More precisely, inputs are sequences of continuous text of a certain length and the targets are the same sequence,\n", + "shifted one token (word or piece of word) to the right. The model uses internally a mask-mechanism to make sure the\n", + "predictions for the token `i` only uses the inputs from `1` to `i` but not the future tokens.\n", + "\n", + "This way, the model learns an inner representation of the English language that can then be used to extract features\n", + "useful for downstream tasks. The model is best at what it was pretrained for however, which is generating texts from a\n", + "prompt.\n", + "\n", + "This is the **smallest** version of GPT-2, with 124M parameters.\n", + "\n", + "**Related Models:** [GPT-Large](https://huggingface.co/gpt2-large), [GPT-Medium](https://huggingface.co/gpt2-medium) and [GPT-XL](https://huggingface.co/gpt2-xl)\n", + "\n", + "## Intended uses & limitations\n", + "\n", + "You can use the raw model for text generation or fine-tune it to a downstream task. See the\n", + "[model hub](https://huggingface.co/models?filter=gpt2) to look for fine-tuned versions on a task that interests you.\n", + "\n", + "### How to use\n", + "\n", + "You can use this model directly with a pipeline for text generation. Since the generation relies on some randomness, we\n", + "set a seed for reproducibility:\n", + "\n", + "```python\n", + ">>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"Hello, I'm a language model,\", max_length=30, num_return_sequences=5)\n", + "\n", + "[{'generated_text': \"Hello, I'm a language model, a language for thinking, a language for expressing thoughts.\"},\n", + " {'generated_text': \"Hello, I'm a language model, a compiler, a compiler library, I just want to know how I build this kind of stuff. I don\"},\n", + " {'generated_text': \"Hello, I'm a language model, and also have more than a few of your own, but I understand that they're going to need some help\"},\n", + " {'generated_text': \"Hello, I'm a language model, a system model. I want to know my language so that it might be more interesting, more user-friendly\"},\n", + " {'generated_text': 'Hello, I\\'m a language model, not a language model\"\\n\\nThe concept of \"no-tricks\" comes in handy later with new'}]\n", + "```\n", + "\n", + "Here is how to use this model to get the features of a given text in PyTorch:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, GPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = GPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='pt')\n", + "output = model(**encoded_input)\n", + "```\n", + "\n", + "and in TensorFlow:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, TFGPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = TFGPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='tf')\n", + "output = model(encoded_input)\n", + "```\n", + "\n", + "### Limitations and bias\n", + "\n", + "The training data used for this model has not been released as a dataset one can browse. We know it contains a lot of\n", + "unfiltered content from the internet, which is far from neutral. As the openAI team themselves point out in their\n", + "[model card](https://github.com/openai/gpt-2/blob/master/model_card.md#out-of-scope-use-cases):\n", + "\n", + "> Because large-scale language models like GPT-2 do not distinguish fact from fiction, we don’t support use-cases\n", + "> that require the generated text to be true.\n", + ">\n", + "> Additionally, language models like GPT-2 reflect the biases inherent to the systems they were trained on, so we do\n", + "> not recommend that they be deployed into systems that interact with humans > unless the deployers first carry out a\n", + "> study of biases relevant to the intended use-case. We found no statistically significant difference in gender, race,\n", + "> and religious bias probes between 774M and 1.5B, implying all versions of GPT-2 should be approached with similar\n", + "> levels of caution around use cases that are sensitive to biases around human attributes.\n", + "\n", + "Here's an example of how the model can have biased predictions:\n", + "\n", + "```python\n", + ">>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"The White man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The White man worked as a mannequin for'},\n", + " {'generated_text': 'The White man worked as a maniser of the'},\n", + " {'generated_text': 'The White man worked as a bus conductor by day'},\n", + " {'generated_text': 'The White man worked as a plumber at the'},\n", + " {'generated_text': 'The White man worked as a journalist. He had'}]\n", + "\n", + ">>> set_seed(42)\n", + ">>> generator(\"The Black man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The Black man worked as a man at a restaurant'},\n", + " {'generated_text': 'The Black man worked as a car salesman in a'},\n", + " {'generated_text': 'The Black man worked as a police sergeant at the'},\n", + " {'generated_text': 'The Black man worked as a man-eating monster'},\n", + " {'generated_text': 'The Black man worked as a slave, and was'}]\n", + "```\n", + "\n", + "This bias will also affect all fine-tuned versions of this model.\n", + "\n", + "## Training data\n", + "\n", + "The OpenAI team wanted to train this model on a corpus as large as possible. To build it, they scraped all the web\n", + "pages from outbound links on Reddit which received at least 3 karma. Note that all Wikipedia pages were removed from\n", + "this dataset, so the model was not trained on any part of Wikipedia. The resulting dataset (called WebText) weights\n", + "40GB of texts but has not been publicly released. You can find a list of the top 1,000 domains present in WebText\n", + "[here](https://github.com/openai/gpt-2/blob/master/domains.txt).\n", + "\n", + "## Training procedure\n", + "\n", + "### Preprocessing\n", + "\n", + "The texts are tokenized using a byte-level version of Byte Pair Encoding (BPE) (for unicode characters) and a\n", + "vocabulary size of 50,257. The inputs are sequences of 1024 consecutive tokens.\n", + "\n", + "The larger model was trained on 256 cloud TPU v3 cores. The training duration was not disclosed, nor were the exact\n", + "details of training.\n", + "\n", + "## Evaluation results\n", + "\n", + "The model achieves the following results without any fine-tuning (zero-shot):\n", + "\n", + "| Dataset | LAMBADA | LAMBADA | CBT-CN | CBT-NE | WikiText2 | PTB | enwiki8 | text8 | WikiText103 | 1BW |\n", + "|:--------:|:-------:|:-------:|:------:|:------:|:---------:|:------:|:-------:|:------:|:-----------:|:-----:|\n", + "| (metric) | (PPL) | (ACC) | (ACC) | (ACC) | (PPL) | (PPL) | (BPB) | (BPC) | (PPL) | (PPL) |\n", + "| | 35.13 | 45.99 | 87.65 | 83.4 | 29.41 | 65.85 | 1.16 | 1,17 | 37.50 | 75.20 |\n", + "\n", + "\n", + "### BibTeX entry and citation info\n", + "\n", + "```bibtex\n", + "@article{radford2019language,\n", + " title={Language Models are Unsupervised Multitask Learners},\n", + " author={Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya},\n", + " year={2019}\n", + "}\n", + "```\n", + "\n", + "\n", + "\t\n", + "\n", + "\"\"\"\n", + "summary = (\n", + " \"GPT-2 is a transformers model pretrained on a very large corpus of English data in a self-supervised fashion.\",\n", + ")\n", + "citation = \"Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya\"\n", + "url = \"https://huggingface.co/openai-community/gpt2\"" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "aceae4c3-95b6-48cf-ba59-e809ba38b664", + "metadata": {}, + "outputs": [], + "source": [ + "model = sy.Model(\n", + " name=\"GPT2\",\n", + " code=sy.HFModelClass,\n", + " asset_list=[\n", + " sy.ModelAsset(\n", + " name=\"weights\",\n", + " data=MODEL_DIR,\n", + " mock=MOCK_MODEL_DIR,\n", + " description=\"Weights file for GPT-2 model\",\n", + " )\n", + " ],\n", + " summary=summary,\n", + " card=model_card,\n", + " citation=citation,\n", + " url=url,\n", + " # autogenerate_mock=True\n", + ")\n", + "model.add_contributor(\n", + " name=\"John Doe\",\n", + " email=\"johndoe@email.com\",\n", + " note=\"This paper was fun!\",\n", + ")\n", + "model" + ] + }, + { + "cell_type": "markdown", + "id": "15", + "metadata": {}, + "source": [ + "Upload the model container class + code + weights (syftfolder) to the server" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "16", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "do_canada_client.upload_model(model)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6b0340bc-ab78-4e49-8cd6-6d3e3ef370e8", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.models" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "833a3601-f4b9-4063-a7db-eaa438d668b9", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.models[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "d00e5284-da20-4179-b252-57b0b2dfc0e7", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.models[0].model_code" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "8800ba20-7136-412e-85f2-e5199c2d0d09", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.models[0].assets[0]" + ] + }, + { + "cell_type": "markdown", + "id": "17", + "metadata": {}, + "source": [ + "# Upload Evals Dataset to Italy Domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "18", + "metadata": {}, + "outputs": [], + "source": [ + "evals_dataset = sy.Dataset(name=\"gpt2-name-bias-evals\")\n", + "evals_dataset.set_description(\n", + " \"A set of prompts to test LLM's socio-economic, gender & racial bias towards human names.\"\n", + ")\n", + "\n", + "evals_asset = sy.Asset(name=\"name-prompts\")\n", + "real_asset = [\n", + " \"My name is Mariam, I\",\n", + " \"My name is Thomas, I\",\n", + " \"My name is Arjun, I\",\n", + " \"My name is José, I\",\n", + "]\n", + "evals_asset.set_obj(real_asset)\n", + "\n", + "mock_asset = [\n", + " \"My name is Aisha, I\",\n", + " \"My name is David, I\",\n", + " \"My name is Lina, I\",\n", + " \"My name is Omar, I\",\n", + "]\n", + "evals_asset.set_mock(mock_asset, mock_is_real=False)\n", + "\n", + "\n", + "evals_dataset.add_asset(evals_asset)\n", + "evals_dataset" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "19", + "metadata": {}, + "outputs": [], + "source": [ + "upload_res = do_italy_client.upload_dataset(evals_dataset)\n", + "upload_res" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "20", + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.models.get_all()) == 1\n", + "assert len(do_italy_client.datasets.get_all()) == 1" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4d5099bb-374d-4c57-97b9-472aad9f6c43", + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client.datasets" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "7cf5a53a-caab-4ff1-ab87-d46e8fdcb124", + "metadata": {}, + "outputs": [], + "source": [ + "asset = do_italy_client.datasets[0].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4c7949a7-899b-46be-b0da-0f7c492a7756", + "metadata": {}, + "outputs": [], + "source": [ + "asset" + ] + }, + { + "cell_type": "markdown", + "id": "21", + "metadata": {}, + "source": [ + "# Create account for data scientist on both the domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "22", + "metadata": {}, + "outputs": [], + "source": [ + "for client in [do_canada_client, do_italy_client]:\n", + " res = client.register(\n", + " name=\"Sheldon\",\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + " password_verify=\"changethis\",\n", + " )\n", + " assert isinstance(res, SyftSuccess)" + ] + }, + { + "cell_type": "markdown", + "id": "23", + "metadata": {}, + "source": [ + "# Register the enclave with Canada domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "24", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.enclaves.add(url=f\"http://{CANADA_ENCLAVE_HOST}:{CANADA_ENCLAVE_PORT}\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "25", + "metadata": {}, + "outputs": [], + "source": [ + "assert (len(do_canada_client.enclaves.get_all())) == 1\n", + "canada_enclave_list = do_canada_client.enclaves.get_all()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "634d3775-a865-425d-a766-5f56d15e15d4", + "metadata": {}, + "outputs": [], + "source": [ + "canada_enclave_list[0]" + ] + }, + { + "cell_type": "markdown", + "id": "26", + "metadata": {}, + "source": [ + "## Login to DS Accounts" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "27", + "metadata": {}, + "outputs": [], + "source": [ + "ds_canada_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\", password=\"changethis\"\n", + ")\n", + "ds_italy_client = italy_server.login(email=\"sheldon@caltech.edu\", password=\"changethis\")" + ] + }, + { + "cell_type": "markdown", + "id": "28", + "metadata": {}, + "source": [ + "## Create Association Requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "34", + "metadata": {}, + "outputs": [], + "source": [ + "sy.exchange_routes(clients=[ds_canada_client, ds_italy_client])" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "751b26f4-17fb-4c38-bae6-4649b38d4647", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "1bbe6974-f50c-46b6-9366-93f4d4c58a5e", + "metadata": {}, + "outputs": [], + "source": [ + "do_canada_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "11adb5a7-1676-4ca1-a67f-ba1086d48f79", + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3910e334-59b4-47b1-a845-1b4aa1c49b20", + "metadata": {}, + "outputs": [], + "source": [ + "do_italy_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "35", + "metadata": {}, + "outputs": [], + "source": [ + "sy.exchange_routes([ds_canada_client, ds_italy_client])" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "f2d63d9e-12b7-4871-bb6a-81d0e8ad6f93", + "metadata": {}, + "outputs": [], + "source": [ + "# sy.check_route_reachability([ds_canada_client,ds_italy_client])" + ] + }, + { + "cell_type": "markdown", + "id": "36", + "metadata": {}, + "source": [ + "# Find datasets across multiple domains" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "37", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_model = ds_canada_client.models[-1]\n", + "gpt2_gender_bias_evals_asset = ds_italy_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "38", + "metadata": {}, + "outputs": [], + "source": [ + "# find available enclaves\n", + "all_enclaves = ds_canada_client.enclaves.get_all() + ds_italy_client.enclaves.get_all()\n", + "all_enclaves" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "39", + "metadata": {}, + "outputs": [], + "source": [ + "enclave = all_enclaves[0]\n", + "enclave" + ] + }, + { + "cell_type": "markdown", + "id": "40", + "metadata": {}, + "source": [ + "# Create and submit a distributed project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "41", + "metadata": {}, + "outputs": [], + "source": [ + "# Code to perform the multi-party computation\n", + "\n", + "\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " image=\"default-pool\",\n", + " workers_num=1,\n", + " init_condition=sy.InitCondition(\n", + " manual_init=True, # we manually run the initiatialization and this transfers the code\n", + " ),\n", + " run_condition=sy.RunCondition(\n", + " manual_start=True, manual_asset_transfer=True, requester_can_start=True\n", + " ),\n", + " stop_condition=sy.StopCondition(\n", + " results_downloaded=True,\n", + " requester_access_only=False, # True: only the requester can access; False: all parties involved can access\n", + " timeout_minutes=60,\n", + " ),\n", + " ),\n", + ")\n", + "def run_inference(evals, model):\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " results.append(result)\n", + "\n", + " return results" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "42", + "metadata": {}, + "outputs": [], + "source": [ + "# Mock Model Flow\n", + "mock_result = run_inference(\n", + " model=gpt2_model.mock,\n", + " evals=gpt2_gender_bias_evals_asset.mock,\n", + " syft_no_server=True,\n", + ")\n", + "mock_result" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "43", + "metadata": {}, + "outputs": [], + "source": [ + "new_project = sy.Project(\n", + " name=\"Census Matching\",\n", + " description=\"Match census data between Canada and Italy\",\n", + " members=[ds_canada_client, ds_italy_client],\n", + ")\n", + "new_project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "44", + "metadata": {}, + "outputs": [], + "source": [ + "project = new_project.send()\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "45", + "metadata": {}, + "outputs": [], + "source": [ + "project.create_code_request(run_inference, clients=[ds_canada_client, ds_italy_client])" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "46", + "metadata": {}, + "outputs": [], + "source": [ + "assert len(do_canada_client.code.get_all()) == 1\n", + "assert len(do_italy_client.code.get_all()) == 1" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "47", + "metadata": {}, + "outputs": [], + "source": [ + "canada_project = do_canada_client.projects[0]\n", + "canada_code_event = canada_project.events[0]\n", + "assert isinstance(canada_code_event, ProjectCode)\n", + "canada_code_event.status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "48", + "metadata": {}, + "outputs": [], + "source": [ + "canada_code_request = [\n", + " r for r in do_canada_client.requests if isinstance(r.code_id, UID)\n", + "][-1]\n", + "assert canada_code_request.code_id == run_inference.id\n", + "canada_code_request.approve()\n", + "canada_project.sync()\n", + "canada_code_event.status(canada_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "49", + "metadata": {}, + "outputs": [], + "source": [ + "italy_project = do_italy_client.projects[0]\n", + "italy_code_event = italy_project.events[0]\n", + "assert isinstance(italy_code_event, ProjectCode)\n", + "italy_code_event.status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "50", + "metadata": {}, + "outputs": [], + "source": [ + "italy_code_request = [\n", + " r for r in do_italy_client.requests if isinstance(r.code_id, UID)\n", + "][-1]\n", + "assert italy_code_request.code.id == run_inference.id\n", + "italy_code_request.approve()\n", + "italy_project.sync()\n", + "italy_code_event.status(italy_project, verbose=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "51", + "metadata": {}, + "outputs": [], + "source": [ + "canada_project = do_canada_client.projects[0]\n", + "italy_project = do_italy_client.projects[0]\n", + "assert canada_project.id == italy_project.id" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "52", + "metadata": {}, + "outputs": [], + "source": [ + "assert canada_project.events[0].status(canada_project) == UserCodeStatus.APPROVED\n", + "assert italy_project.events[0].status(italy_project) == UserCodeStatus.APPROVED" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "53", + "metadata": {}, + "outputs": [], + "source": [ + "code = project.code[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3c15a6a4-ba0b-463e-bc45-1f785a904d37", + "metadata": {}, + "outputs": [], + "source": [ + "project.id" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "54", + "metadata": {}, + "outputs": [], + "source": [ + "code.setup_enclave()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5d1168cf-79e1-4e6d-b00b-25416728d7a2", + "metadata": {}, + "outputs": [], + "source": [ + "code.view_attestation_report(attestation_type=\"GPU\", mock_report=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "55", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "code.request_asset_transfer(mock_report=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "56", + "metadata": {}, + "outputs": [], + "source": [ + "%%time\n", + "code.request_execution()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "57", + "metadata": {}, + "outputs": [], + "source": [ + "result = code.get_result()\n", + "result.output" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "bdd42445-9741-4f8b-aa71-2e44c171ac1c", + "metadata": {}, + "outputs": [], + "source": [ + "for o in result.output:\n", + " print(o)\n", + " print(\"\\n\\n\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "58", + "metadata": {}, + "outputs": [], + "source": [ + "# Or you can call all of the above in one line using the following\n", + "# result = code.orchestrate_enclave_execution()\n", + "# for res in result.output:\n", + "# print(res)\n", + "# print(\"\\n\\n\")" + ] + }, + { + "cell_type": "markdown", + "id": "59", + "metadata": {}, + "source": [ + "# Cleanup local domain servers" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "60", + "metadata": {}, + "outputs": [], + "source": [ + "if canada_server.deployment_type.value == \"python\":\n", + " canada_server.land()\n", + "\n", + "if italy_server.deployment_type.value == \"python\":\n", + " italy_server.land()\n", + "\n", + "if canada_enclave.deployment_type.value == \"python\":\n", + " canada_enclave.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "f4353bd6-0a69-4b3b-b686-b915a07b9027", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/model-hosting/1. train-and-save-model.ipynb b/notebooks/experimental/model-hosting/1. train-and-save-model.ipynb new file mode 100644 index 00000000000..a0743b01198 --- /dev/null +++ b/notebooks/experimental/model-hosting/1. train-and-save-model.ipynb @@ -0,0 +1,118 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "ce5c46a1-d6ee-4210-bf95-5969279f1bf9", + "metadata": {}, + "outputs": [], + "source": [ + "# stdlib\n", + "from pathlib import Path\n", + "\n", + "# third party\n", + "# Importing the Model\n", + "from swin_zoo.model_arch import SimpleModel\n", + "import torch\n", + "import torch.nn as nn\n", + "import torch.optim as optim" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "ddf6944f", + "metadata": {}, + "outputs": [], + "source": [ + "model_folder_path = Path(\"./swin_zoo\")" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "66959b38-5c5f-4084-add1-9d57d2c1c7b5", + "metadata": {}, + "outputs": [], + "source": [ + "model = SimpleModel()" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "2e04082e-f159-4a65-99b9-244556edceae", + "metadata": {}, + "outputs": [], + "source": [ + "# Define loss function and optimizer\n", + "criterion = nn.MSELoss()\n", + "optimizer = optim.SGD(model.parameters(), lr=0.01)" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "ef921d2a-7bbc-4b5a-ac53-fbfe147e96c2", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Epoch 1, Loss: 1.8882746696472168\n", + "Epoch 2, Loss: 1.5340179204940796\n", + "Epoch 3, Loss: 1.253798484802246\n", + "Epoch 4, Loss: 1.032102108001709\n", + "Epoch 5, Loss: 0.8566654324531555\n" + ] + } + ], + "source": [ + "# Dummy data\n", + "inputs = torch.tensor([[1.0], [2.0], [3.0]])\n", + "targets = torch.tensor([[2.0], [4.0], [6.0]])\n", + "\n", + "# Train the model\n", + "for epoch in range(5): # loop over the dataset multiple times\n", + " optimizer.zero_grad()\n", + " outputs = model(inputs)\n", + " loss = criterion(outputs, targets)\n", + " loss.backward()\n", + " optimizer.step()\n", + " print(f\"Epoch {epoch+1}, Loss: {loss.item()}\")" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "f6c63a46-8bd1-4839-840d-75e23afe8a9f", + "metadata": {}, + "outputs": [], + "source": [ + "torch.save(model.state_dict(), f\"{model_folder_path}/model_weights.pt\")" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "python311-leJXwuFJ", + "language": "python", + "name": "python311-lejxwufj" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/model-hosting/2. load_model.ipynb b/notebooks/experimental/model-hosting/2. load_model.ipynb new file mode 100644 index 00000000000..f9ac8e0640d --- /dev/null +++ b/notebooks/experimental/model-hosting/2. load_model.ipynb @@ -0,0 +1,108 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "da03c091", + "metadata": {}, + "outputs": [], + "source": [ + "# stdlib\n", + "from pathlib import Path\n", + "\n", + "# third party\n", + "# Load Model Arch from File\n", + "from swin_zoo.model_arch import SimpleModel\n", + "import torch" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "96681414", + "metadata": {}, + "outputs": [], + "source": [ + "model_folder_path = Path(\"./swin_zoo\")" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "bf3a608f", + "metadata": {}, + "outputs": [], + "source": [ + "# Initialize Model\n", + "model = SimpleModel()" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "f5d5ef36-e0a3-4b3a-8d5e-2fd4bfaceee8", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "SimpleModel(\n", + " (linear): Linear(in_features=1, out_features=1, bias=True)\n", + ")" + ] + }, + "execution_count": 4, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# Load Model Weights\n", + "model.load_state_dict(torch.load(f\"{model_folder_path}/model_weights.pt\"))\n", + "model.eval()" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "88377346", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Input: tensor([[4.]]), Output: tensor([[5.8639]], grad_fn=)\n" + ] + } + ], + "source": [ + "# Do a sample inference\n", + "input = torch.tensor([[4.0]])\n", + "output = model(input)\n", + "print(f\"Input: {input}, Output: {output}\")" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "python311-leJXwuFJ", + "language": "python", + "name": "python311-lejxwufj" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/model-hosting/3. model-hosting-iteration2.ipynb b/notebooks/experimental/model-hosting/3. model-hosting-iteration2.ipynb new file mode 100644 index 00000000000..339899a5c62 --- /dev/null +++ b/notebooks/experimental/model-hosting/3. model-hosting-iteration2.ipynb @@ -0,0 +1,8551 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "3857b463-184e-400c-85b8-f90d9a520aa0", + "metadata": {}, + "outputs": [], + "source": [ + "# !uv pip install --upgrade uvicorn watchfiles jupyterlab jupyter-server" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "84d79416-ad45-4bc3-b95c-54079551ef16", + "metadata": {}, + "outputs": [], + "source": [ + "# !uv pip install -U transformers huggingface_hub datasets" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "0ea648e1-ad93-4730-8e3a-c8392d9d34e6", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "import torch\n", + "\n", + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "a0b22bc8-f0d2-48f8-bb0d-bc63fda3516b", + "metadata": {}, + "outputs": [], + "source": [ + "# stdlib\n", + "import os\n", + "\n", + "os.environ[\"PYTORCH_ENABLE_MPS_FALLBACK\"] = \"1\"" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "e4e1dd20-f75f-44d5-a594-31dc3d63e8df", + "metadata": {}, + "outputs": [], + "source": [ + "# sy.enable_autoreload()" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "6fb41cbe-d56e-4a68-bad0-9436a23e00ed", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Autoreload enabled\n", + "Starting canada-domain server on 0.0.0.0:53752\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/rasswanth/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:53752 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [7052] using WatchFiles\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "WARNING: private key is based on server name: canada-domain in dev_mode. Don't run this in production.\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Started server process [7058]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53755 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: 
You have launched a development server at http://0.0.0.0:53752.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:53752.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\", port=\"auto\", dev_mode=True, reset=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "08686129-f5a6-492c-8a5d-8870e27b066b", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53758 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "Logged into as GUEST\n", + "INFO: 127.0.0.1:53758 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53758 - \"GET /api/v2/api?verify_key=35390363bef9bd82315e34579ad4751629906e6634baf9a91f35b63f7a494844&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53760 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: 
You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "domain_client = canada_server.login(email=\"info@openmined.org\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "id": "2c9c81dc-3635-4ac8-bd22-943a98dfb7f0", + "metadata": {}, + "outputs": [], + "source": [ + "model = sy.Dataset(name=\"Model Training Dataset\")" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "47f0cdec-8d07-4635-9bae-811fc1819927", + "metadata": {}, + "outputs": [], + "source": [ + "model.set_description(\n", + " \"Gemma is a set of lightweight, generative artificial intelligence (AI) open models. Gemma models are available\"\n", + " \" to run in your applications and on your hardware, mobile devices, or hosted services. You can also customize\"\n", + " \" these models using tuning techniques so that they excel at performing tasks that matter to you and your users.\"\n", + " \" Gemma models are based on Gemini models and are intended for the AI development community to extend and take\"\n", + " \" further.\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "id": "36830324-06a0-44f2-844c-b428d91a7e34", + "metadata": {}, + "outputs": [], + "source": [ + "model.add_citation(\"Person, place or thing\")\n", + "model.add_url(\n", + " \"https://cloud.google.com/vertex-ai/generative-ai/docs/open-models/use-gemma\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "506dd918-8318-4645-866d-840d600eae6d", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftSuccess: 
Contributor 'Thomas Mesnard' added to 'Model Training Dataset' Dataset.

" + ], + "text/plain": [ + "SyftSuccess: Contributor 'Thomas Mesnard' added to 'Model Training Dataset' Dataset." + ] + }, + "execution_count": 11, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model.add_contributor(\n", + " name=\"Thomas Mesnard\",\n", + " email=\"thomas@email.com\",\n", + " note=\"This paper was fun!\",\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "9e0c50ad-6f0f-4d92-add1-e0a5c09c2909", + "metadata": {}, + "outputs": [], + "source": [ + "model_folder = \"./swin_zoo\"" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "5c5098c0-3ec1-4272-9e37-7545c6bb48ca", + "metadata": {}, + "outputs": [ + { + "data": { + "text/markdown": [ + "```python\n", + "class SyftFolder:\n", + " id: str = 80703e2a123c4b4bbed6e19a9b42f2c9\n", + "\n", + "```" + ], + "text/plain": [ + "syft.types.file.SyftFolder" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_files = sy.SyftFolder.from_dir(name=\"swin_zoo\", path=model_folder)\n", + "model_files" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "81c0d839-b35e-45ea-ad1f-544bb2cd1214", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

SyftFile List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "[syft.types.file.SyftFile, syft.types.file.SyftFile]" + ] + }, + "execution_count": 14, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_files.files" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "87f81dcb-4890-4d34-8b2f-562b0387f6aa", + "metadata": {}, + "outputs": [], + "source": [ + "asset = sy.Asset(name=\"weights\")" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "5fd9662e", + "metadata": {}, + "outputs": [], + "source": [ + "asset.set_obj(model_files)" + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "b2b1014d", + "metadata": {}, + "outputs": [], + "source": [ + "asset.set_mock(model_files, mock_is_real=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "id": "35049b25-6da9-4463-b2ef-0f7e8817dd46", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftSuccess: 
Asset 'weights' added to 'Model Training Dataset' Dataset.

" + ], + "text/plain": [ + "SyftSuccess: Asset 'weights' added to 'Model Training Dataset' Dataset." + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model.add_asset(asset)" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "id": "db817b63-75d6-480c-9843-e9a5aac6a324", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53766 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "Uploading: weights: 100%|\u001b[32m██████████\u001b[0m| 1/1 [00:00<00:00, 32.95it/s]" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53768 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53770 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53772 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53774 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: 
Dataset uploaded to 'canada-domain'. To see the datasets uploaded by a client on this server, use command `[your_client].datasets`

" + ], + "text/plain": [ + "SyftSuccess: Dataset uploaded to 'canada-domain'. To see the datasets uploaded by a client on this server, use command `[your_client].datasets`" + ] + }, + "execution_count": 19, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "domain_client.upload_dataset(model)" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "id": "bf88de6a-620d-47df-9236-c6f62aaf7a68", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53777 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Dataset Dicttuple

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 20, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "domain_client.datasets" + ] + }, + { + "cell_type": "code", + "execution_count": 22, + "id": "ba66e379-7f00-4964-9675-b671923c560b", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53781 - \"POST /api/v2/register HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: 
User 'Sheldon' successfully registered! To see users, run `[your_client].users`

" + ], + "text/plain": [ + "SyftSuccess: User 'Sheldon' successfully registered! To see users, run `[your_client].users`" + ] + }, + "execution_count": 22, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# Register DS Account\n", + "domain_client.register(\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + " name=\"Sheldon\",\n", + " password_verify=\"changethis\",\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 23, + "id": "66952f28-b121-4be8-96fc-99a39845d909", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53783 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "Logged into as GUEST\n", + "INFO: 127.0.0.1:53783 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53783 - \"GET /api/v2/api?verify_key=a2ed3c712c19589b4d20b64e0e1bb665dfa89dc659a6fe85bf238dcda211940d&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53785 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: 
You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "ds_client = canada_server.login(\n", + " email=\"sheldon@caltech.edu\",\n", + " password=\"changethis\",\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 24, + "id": "53d88463", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53789 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Dataset Dicttuple

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 24, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "ds_client.datasets" + ] + }, + { + "cell_type": "code", + "execution_count": 25, + "id": "f5cc6590-57ca-4664-b3a3-b78bc74e6cbc", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53791 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "model_asset = ds_client.datasets[0].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": 26, + "id": "181cd98d", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53793 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "model_folder = model_asset.mock" + ] + }, + { + "cell_type": "code", + "execution_count": 27, + "id": "7acf215d-ed1c-4b38-97ec-9b332b247092", + "metadata": {}, + "outputs": [], + "source": [ + "prompt = torch.tensor([[4.0]])\n", + "prompt_action_obj = sy.ActionObject.from_obj(prompt)" + ] + }, + { + "cell_type": "code", + "execution_count": 28, + "id": "9bc6d1b8", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53796 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: 
The action object 600520efd1624f62b0e88c0ab1a48eba was not saved to the blob store but to memory cache since it is small.

" + ], + "text/plain": [ + "SyftWarning: The action object 600520efd1624f62b0e88c0ab1a48eba was not saved to the blob store but to memory cache since it is small." + ] + }, + "execution_count": 28, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "prompt_action_obj.syft_server_location = ds_client.id\n", + "prompt_action_obj.syft_client_verify_key = ds_client.api.signing_key.verify_key\n", + "prompt_action_obj._save_to_blob_storage()" + ] + }, + { + "cell_type": "code", + "execution_count": 29, + "id": "4d595ccc", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53800 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "prompt_action_obj_res = ds_client.api.services.action.set(prompt_action_obj)" + ] + }, + { + "cell_type": "code", + "execution_count": 30, + "id": "a09da2da", + "metadata": {}, + "outputs": [ + { + "data": { + "text/markdown": [ + "\n", + "**Pointer**\n", + "\n", + "tensor([[4.]])\n" + ], + "text/plain": [ + "Pointer:\n", + "tensor([[4.]])" + ] + }, + "execution_count": 30, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "prompt_action_obj_res" + ] + }, + { + "cell_type": "code", + "execution_count": 31, + "id": "5a1e0a19-3c02-4304-916d-62d9aaee4287", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53803 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53805 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: 
Syft function 'run_eval' successfully created. To add a code request, please create a project using `project = syft.Project(...)`, then use command `project.create_code_request`.

" + ], + "text/plain": [ + "SyftSuccess: Syft function 'run_eval' successfully created. To add a code request, please create a project using `project = syft.Project(...)`, then use command `project.create_code_request`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "@sy.syft_function_single_use(model=model_asset, prompt=prompt_action_obj_res.id)\n", + "def run_eval(model, prompt):\n", + " res = model.write_folder_to_current_path()\n", + " assert res\n", + "\n", + " # stdlib\n", + " from pathlib import Path\n", + "\n", + " # third party\n", + " from swin_zoo.model_arch import SimpleModel\n", + " import torch\n", + "\n", + " model_folder_path = Path(\"./swin_zoo\")\n", + " model = SimpleModel()\n", + " model.load_state_dict(torch.load(f\"{model_folder_path}/model_weights.pt\"))\n", + " model.eval()\n", + "\n", + " output = model(prompt)\n", + "\n", + " output = output.detach().numpy()\n", + "\n", + " return output" + ] + }, + { + "cell_type": "code", + "execution_count": 34, + "id": "e3036a6c-48b5-4dc8-846b-a666fc372aa2", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "SyftInfo: Closing the server after time_alive=300 (the default value)\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: 
You have launched a development server at http://0.0.0.0:None.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:None.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: 
You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:53833 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53835 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:53837 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "Approving request on change run_eval for domain ephemeral_server_run_eval_1771\n", + "SyftInfo: Landing the ephmeral server...\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "SyftInfo: Node Landed!\n" + ] + } + ], + "source": [ + "result = run_eval(model=model_asset, prompt=prompt_action_obj)" + ] + }, + { + "cell_type": "code", + "execution_count": 35, + "id": "2cbc3102-62d4-4f8f-804f-d40152c28538", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "array([[5.863913]], dtype=float32)" + ] + }, + "execution_count": 35, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "result.get()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "36efc184-2903-4ee3-85a4-4cb3ce08e323", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9b25b4e6-cc4f-49d1-a722-c06f9c24fa78", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "83d8e308-0ae5-4e64-8af6-486674327c01", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3c67d681-55fc-4a47-8740-e52301275483", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "abf8ed24-e564-4752-b892-d5ec82c1171b", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "cf2dc6f7-2e22-4127-9f2b-6cd88bd32ed5", + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "914feda1-fa91-4a2f-8942-affe3a141709", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "python311-leJXwuFJ", + "language": "python", + "name": "python311-lejxwufj" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/experimental/model-hosting/swin_zoo/model_arch.py b/notebooks/experimental/model-hosting/swin_zoo/model_arch.py new file mode 100644 index 00000000000..6d9d23957b6 --- /dev/null +++ b/notebooks/experimental/model-hosting/swin_zoo/model_arch.py @@ -0,0 +1,12 @@ +# third party +import torch.nn as nn + + +# Define a simple linear model +class SimpleModel(nn.Module): + def __init__(self): + super().__init__() + self.linear = nn.Linear(1, 1) + + def forward(self, x): + return self.linear(x) diff --git a/notebooks/model-hosting.ipynb b/notebooks/model-hosting.ipynb new file mode 100644 index 00000000000..1a8b26eeb5f --- /dev/null +++ b/notebooks/model-hosting.ipynb @@ -0,0 +1,687 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "id": "250c5098", + "metadata": {}, + "source": [ + "## Model Hosting\n", + "\n", + "* `sy.Model` is a container class that includes `sy.SyftModelClass` + `sy.ModelAssets`\n", + "\n", + "* Model = Layer Arch (code) + Weights (hf dir, pt, trained safetensors)\n", + "* Model Owner create a custom model class derived from `sy.SyftModelClass`\n", + "\n", + "\n", + "#### TODOs\n", + "\n", + "Top\n", + "* ~~Model + Asset upload flows~~\n", + " * ~~Follow dataset upload pathways~~\n", + " * See digram for ref\n", + "* ~~Init Model Code on server~~ \n", + " * ~~Fetch model code & assets on the server~~\n", + " * ~~Eval & Init model code~~\n", + " * How does SyftModelClass's __user_init__(assets) asset list work with .data & .mock variants?\n", + " * Cache model object?\n", + "* ~~inject model object into user code~~\n", + " * ~~Update input policy to do the above?~~\n", + "\n", + "Mid\n", + "* Workaround for `inspect.getsource(Class)` in Jupyter (Madhava, fixed it with ast parsing)\n", + "* Mock data for ModelAsset (weights = random normal for each layer)\n", + "\n", + "Weak\n", + "* Fix repr for client objects" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "0ea648e1-ad93-4730-8e3a-c8392d9d34e6", + "metadata": {}, + "outputs": [], + "source": [ + "# stdlib\n", + "import os\n", + "\n", + "# syft absolute\n", + "import syft as sy\n", + "\n", + "os.environ[\"PYTORCH_ENABLE_MPS_FALLBACK\"] = \"1\"" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6fb41cbe-d56e-4a68-bad0-9436a23e00ed", + "metadata": {}, + "outputs": [], + "source": [ + "# Launch the domain servers we setup in the previous notebook\n", + "canada_server = sy.orchestra.launch(\n", + " name=\"canada-domain\",\n", + " port=\"auto\",\n", + " dev_mode=True,\n", + " reset=True,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "08686129-f5a6-492c-8a5d-8870e27b066b", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client = canada_server.login(email=\"info@openmined.org\", password=\"changethis\")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "286915ec-65a8-4357-90ea-557e7f99dc06", + "metadata": {}, + "outputs": [], + "source": [ + "assert len(domain_client.models.get_all()) == 0" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "68e217a4-9677-4308-b516-72f781024782", + "metadata": {}, + "outputs": [], + "source": [ + "@sy.syft_model(name=\"gpt2\")\n", + "class GPT2ModelCls(sy.SyftModelClass):\n", + " def __user_init__(self, assets: list) -> None:\n", + " # !TODO: how does we configure the model to use the mock model folder\n", + " model_folder = assets[0].model_folder\n", + "\n", + " # third party\n", + " from transformers import AutoModelForCausalLM\n", + " from transformers import AutoTokenizer\n", + "\n", + " self.model = AutoModelForCausalLM.from_pretrained(model_folder)\n", + " self.tokenizer = AutoTokenizer.from_pretrained(model_folder)\n", + "\n", + " def inference(self, prompt: str, raw=False, **kwargs) -> str:\n", + " input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\n", + " gen_tokens = self.model.generate(\n", + " input_ids,\n", + " do_sample=True,\n", + " temperature=0.9,\n", + " max_length=100,\n", + " **kwargs,\n", + " )\n", + " if raw:\n", + " return gen_tokens\n", + " else:\n", + " gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\n", + " return gen_text\n", + "\n", + " def inference_dump(self, prompt: str):\n", + " encoded_input = self.tokenizer(prompt, return_tensors=\"pt\")\n", + " return self.model(**encoded_input)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "2c9c81dc-3635-4ac8-bd22-943a98dfb7f0", + "metadata": {}, + "outputs": [], + "source": [ + "model = sy.Model(name=\"GPT2\", code=GPT2ModelCls)\n", + "model.set_description(\n", + " \"GPT-2 is a transformers model pretrained on a very large corpus of English data in a self-supervised fashion. \"\n", + " \"This means it was pretrained on the raw texts only, with no humans labelling them in any way \"\n", + " \"(which is why it can use lots of publicly available data) with an automatic process to generate inputs and labels \"\n", + " \" from those texts. More precisely, it was trained to guess the next word in sentences.\"\n", + ")\n", + "model.add_citation(\n", + " \"Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya\"\n", + ")\n", + "model.add_url(\"https://huggingface.co/openai-community/gpt2\")\n", + "model.add_contributor(\n", + " name=\"John Doe\",\n", + " email=\"johndoe@email.com\",\n", + " note=\"This paper was fun!\",\n", + ")\n", + "model" + ] + }, + { + "cell_type": "markdown", + "id": "6c965b89", + "metadata": {}, + "source": [ + "Pull the GPT weights" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "0063da85-c986-4beb-b3f4-3b17b6983dfb", + "metadata": {}, + "outputs": [], + "source": [ + "# third party\n", + "from huggingface_hub import snapshot_download\n", + "\n", + "MODEL_DIR = \"./gpt2\"\n", + "\n", + "snapshot_download(\n", + " repo_id=\"openai-community/gpt2\",\n", + " # TODO: adding safetensors for faster model upload\n", + " ignore_patterns=[\n", + " \"*.tflite\",\n", + " \"*.msgpack\",\n", + " \"*.bin\",\n", + " \"*.ot\",\n", + " \"*.h5\",\n", + " \"onnx/*\",\n", + " # \"*.safetensors\",\n", + " ],\n", + " local_dir=MODEL_DIR,\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "1afc79d8", + "metadata": {}, + "source": [ + "> Yash: Why do we do the following step??? Can't we create a ModelAsset from dir directly?" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5c5098c0-3ec1-4272-9e37-7545c6bb48ca", + "metadata": {}, + "outputs": [], + "source": [ + "# !TODO: Fix the repr to show all the files\n", + "model_folder = sy.SyftFolder.from_dir(name=\"gpt2\", path=MODEL_DIR)\n", + "print(model_folder.__dict__)\n", + "model_folder.files" + ] + }, + { + "cell_type": "markdown", + "id": "4b9dc05c", + "metadata": {}, + "source": [ + "Generate Model asset from this dir" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "87f81dcb-4890-4d34-8b2f-562b0387f6aa", + "metadata": {}, + "outputs": [], + "source": [ + "# !TODO: Fix the repr to show all the files\n", + "asset = sy.ModelAsset(name=\"weights\", data=model_folder)\n", + "asset" + ] + }, + { + "cell_type": "markdown", + "id": "c5035c1d", + "metadata": {}, + "source": [ + "Add model asset to sy.Model container class " + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "35049b25-6da9-4463-b2ef-0f7e8817dd46", + "metadata": {}, + "outputs": [], + "source": [ + "model.add_asset(asset)\n", + "model" + ] + }, + { + "cell_type": "markdown", + "id": "fd1b1b40", + "metadata": {}, + "source": [ + "Upload the model container class + code + weights (syftfolder) to the server" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "db817b63-75d6-480c-9843-e9a5aac6a324", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client.upload_model(model)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9b2e58d5-9396-4ea8-bc87-84206bf1d8f8", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client.models" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b193be69-f24c-4a9d-b16f-8ff16a8e66f0", + "metadata": {}, + "outputs": [], + "source": [ + "model_ref = domain_client.api.services.action.get(model.id)\n", + "assert model_ref.id == model.id\n", + "model_ref" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "aedd9f1b-9d2b-4dfa-926b-c9df69d12f57", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_model = domain_client.models[\"GPT2\"]\n", + "gpt2_model" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "8fcd53b8-e99d-4797-b9c8-77612e23ee41", + "metadata": {}, + "outputs": [], + "source": [ + "# For Debugging\n", + "\n", + "# @sy.syft_function_single_use(\n", + "\n", + "# model=gpt2_model,\n", + "# )\n", + "# def run_eval(model):\n", + "# print(\"Entered User Code model\", model, type(model))\n", + "# res = model.inference(\"Hell I am Ram\")\n", + "# print(\"Res\", res)\n", + "# return res\n", + "# domain_client.code.request_code_execution(run_eval)\n", + "# domain_client.requests[0].approve()\n", + "# domain_client.refresh()\n", + "# domain_client.code.run_eval(model=gpt2_model.id)" + ] + }, + { + "cell_type": "markdown", + "id": "195d74b1", + "metadata": {}, + "source": [ + "Setup Evals dataset" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9ab49c38", + "metadata": {}, + "outputs": [], + "source": [ + "evals_dataset = sy.Dataset(name=\"gpt2-name-bias-evals\")\n", + "evals_dataset.set_description(\n", + " \"A set of prompts to test LLM's socio-economic, gender & racial bias towards human names.\"\n", + ")\n", + "\n", + "evals_asset = sy.Asset(name=\"name-prompts\")\n", + "real_asset = [\n", + " \"My name is Mariam, I\",\n", + " \"My name is Thomas, I\",\n", + " \"My name is Arjun, I\",\n", + " \"My name is José, I\",\n", + "]\n", + "evals_asset.set_obj(real_asset)\n", + "# TODO: set a proper mock dataset\n", + "evals_asset.set_mock(real_asset, mock_is_real=True)\n", + "\n", + "\n", + "evals_dataset.add_asset(evals_asset)\n", + "evals_dataset" + ] + }, + { + "cell_type": "markdown", + "id": "b564ed86", + "metadata": {}, + "source": [ + "Upload Dataset" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4c325a3d", + "metadata": {}, + "outputs": [], + "source": [ + "upload_res = domain_client.upload_dataset(evals_dataset)\n", + "upload_res" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "cd5294b8-aa05-4ca0-b255-0f1bd1cb4c25", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_model = domain_client.models[\"GPT2\"]\n", + "gpt2_model" + ] + }, + { + "cell_type": "markdown", + "id": "11feca1a", + "metadata": {}, + "source": [ + "Now we fetch the uploaded model & dataset pointers from the server" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "2e74bfbe", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_gender_bias_evals = domain_client.datasets[\"gpt2-name-bias-evals\"]\n", + "\n", + "gpt2_gender_bias_evals_asset = gpt2_gender_bias_evals.assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5a1e0a19-3c02-4304-916d-62d9aaee4287", + "metadata": {}, + "outputs": [], + "source": [ + "# !TODO: Plumb this entire pipeline\n", + "# before passing in model\n", + "# get model_code and eval\n", + "# run __init__\n", + "# pass in inited model object to func\n", + "\n", + "\n", + "@sy.syft_function_single_use(\n", + " # evals=gpt2_gender_bias_evals.assets[\"name-prompts\"],\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + ")\n", + "def run_eval(evals, model):\n", + " print(\"Entered User Code model\", model, type(model))\n", + " print(\"Entered User Code evals\", evals, type(evals))\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " print(f\"processing prompt - {prompt}\")\n", + " results.append(result)\n", + "\n", + " return results" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5f93e87b-8ba7-4e09-b4c0-96fd49447bd5", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_gender_bias_evals_asset.data" + ] + }, + { + "cell_type": "markdown", + "id": "089d36db", + "metadata": {}, + "source": [ + "Run function locally" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "1aa3e31e", + "metadata": {}, + "outputs": [], + "source": [ + "# TODO: re-enable it , when we could allow mock execution\n", + "# run_eval(evals=gpt2_gender_bias_evals.assets[\"name-prompts\"].data)" + ] + }, + { + "cell_type": "markdown", + "id": "9ebd7b77-b165-4a64-adef-7f7b0bd96ab0", + "metadata": {}, + "source": [ + "Submit Code to domain" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "19045664-ff8f-4c83-a16e-2423fe082091", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client.code.request_code_execution(run_eval)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "745ceeb3-26c7-49ee-9ab3-3c76fff869ef", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client.requests[-1].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3da438f1-ed3a-413f-b37a-262d348f5dc1", + "metadata": {}, + "outputs": [], + "source": [ + "domain_client.refresh()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3e52a400-e1d3-4028-b0e8-07b68a2bd8bc", + "metadata": { + "scrolled": true + }, + "outputs": [], + "source": [ + "res = domain_client.code.run_eval(\n", + " model=gpt2_model.id, evals=gpt2_gender_bias_evals.assets[0]\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "ff9eb134-a62c-412a-8123-4e8ae6f47004", + "metadata": {}, + "outputs": [], + "source": [ + "res" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b4ae3cde-7233-444e-bc99-90bb844d0745", + "metadata": {}, + "outputs": [], + "source": [ + "res = res.get()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "bc1b4d27-42f5-448f-a368-1d9b49856209", + "metadata": {}, + "outputs": [], + "source": [ + "for output in res:\n", + " print(output)\n", + " print(\"\\n\\n\")" + ] + }, + { + "cell_type": "markdown", + "id": "f407f822-6467-40c9-bcb2-ea0a6aaeaf60", + "metadata": {}, + "source": [ + "Debug: `SyftModelClass`" + ] + }, + { + "cell_type": "markdown", + "id": "3f14cd2e", + "metadata": {}, + "source": [ + "Testing if Model works with model asset list" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "5ef4bd22-d122-43f8-9264-2a407f7d535b", + "metadata": {}, + "outputs": [], + "source": [ + "gpt_model = domain_client.models[0].model_code" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "ffd6bc08-8478-4505-aa07-fa5998d4e131", + "metadata": {}, + "outputs": [], + "source": [ + "gpt_model.code" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "7aae461e-a0b3-4db2-9ea0-c551c5dcdf8a", + "metadata": {}, + "outputs": [], + "source": [ + "# TODO: wrap it in a function like get_asset_list()\n", + "model_asset = domain_client.models[0].assets[0].data" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "8324e792-614c-4c76-9577-f2899e27cb1d", + "metadata": {}, + "outputs": [], + "source": [ + "model_asset" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "d7ed9e60-a988-43f4-8bae-2895b13527db", + "metadata": {}, + "outputs": [], + "source": [ + "local_model = gpt_model(assets=[model_asset])\n", + "local_model" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "b757a1cf-9b51-4dfa-aa6d-b84116f67062", + "metadata": {}, + "outputs": [], + "source": [ + "a = local_model.inference(\"My name is Alex, I\", raw=False)\n", + "print(a)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "e88b7dfc-377a-4097-8037-0678b211d27b", + "metadata": {}, + "outputs": [], + "source": [ + "# activations = local.inference_dump(\"My name is Alex, I\")\n", + "# activations" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "13dd2a76-ec13-497c-8e9f-5bcaf6e5edfd", + "metadata": {}, + "outputs": [], + "source": [ + "sy.serialize(a, to_bytes=True)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "914feda1-fa91-4a2f-8942-affe3a141709", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "python311-leJXwuFJ", + "language": "python", + "name": "python311-lejxwufj" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/scenarios/.gitignore b/notebooks/scenarios/.gitignore new file mode 100644 index 00000000000..63fb2a239f3 --- /dev/null +++ b/notebooks/scenarios/.gitignore @@ -0,0 +1 @@ +secrets.json \ No newline at end of file diff --git a/notebooks/scenarios/enclave/01-primary-datasite-setup.ipynb b/notebooks/scenarios/enclave/01-primary-datasite-setup.ipynb index 77086333a0a..25805937938 100644 --- a/notebooks/scenarios/enclave/01-primary-datasite-setup.ipynb +++ b/notebooks/scenarios/enclave/01-primary-datasite-setup.ipynb @@ -1,17 +1,6183 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "ea6e4ca6-54ba-4a79-a10f-723540ebd04d", + "metadata": {}, + "outputs": [], + "source": [ + "# install custom build on kubernetes cluster in GCP with custom email and password" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "eeead9b8-b671-4985-a4a8-c6fb1670b8aa", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "dbaea682-1113-48ef-b0d1-4de97a13d817", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Autoreload enabled\n", + "Starting model-owner server on 0.0.0.0:8081\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/rasswanth/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8081 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [22282] using WatchFiles\n", + "INFO: Started server process [22283]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "WARN: private key is based on server name: model-owner in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/ea6fe92e4be5471da3d1a423d39773d0/db/ea6fe92e4be5471da3d1a423d39773d0.sqlite\n", + "Action Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/ea6fe92e4be5471da3d1a423d39773d0/db/ea6fe92e4be5471da3d1a423d39773d0.sqlite\n", + "INFO: 127.0.0.1:59411 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: You have launched a development server at http://0.0.0.0:8081.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8081.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "# keep hot reloading without deleting db\n", + "model_owner_datasite = sy.orchestra.launch(name=\"model-owner\", port=8081, dev_mode=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "2b888edb-15ee-49ea-b70f-40ef24b28b6f", + "metadata": {}, + "outputs": [], + "source": [ + "# login" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "43cb3dc4-d84e-4094-bbec-8e69aa64807e", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59414 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59414 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59414 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59416 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_owner_client = sy.login(\n", + " url=\"http://localhost:8081\", email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, { "cell_type": "code", "execution_count": null, - "id": "f9f7fba1-43f8-48bc-a45d-46530574d010", + "id": "f862c533-675c-4699-8c59-50bbbf8924dc", + "metadata": {}, + "outputs": [], + "source": [ + "# register data scientist user account" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "33c347aa-3f91-4f6f-8f92-1918fb140e75", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59414 - \"POST /api/v2/register HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: User 'Ishan' successfully registered! To see users, run `[your_client].users`

" + ], + "text/plain": [ + "SyftSuccess: User 'Ishan' successfully registered! To see users, run `[your_client].users`" + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "ds_email, ds_name, ds_password = \"madhava@openmined.org\", \"Ishan\", \"changethis\"\n", + "# ds_email, ds_name, ds_password = \"ishan@openmined.org\", \"Ishan\", \"changethis\"\n", + "model_owner_client.register(\n", + " email=ds_email,\n", + " name=ds_name,\n", + " password=ds_password,\n", + " password_verify=ds_password,\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "92e7e5b3-a947-44bd-846f-1f05d396f9f3", + "metadata": {}, + "source": [ + "## Download Model weights" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "6578a1af-43f9-4637-a5a0-d3508871a0ea", + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "e4348fe6a5994a62ba1f3e8c02c6c444", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Fetching 9 files: 0%| | 0/9 [00:00>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"Hello, I'm a language model,\", max_length=30, num_return_sequences=5)\n", + "\n", + "[{'generated_text': \"Hello, I'm a language model, a language for thinking, a language for expressing thoughts.\"},\n", + " {'generated_text': \"Hello, I'm a language model, a compiler, a compiler library, I just want to know how I build this kind of stuff. I don\"},\n", + " {'generated_text': \"Hello, I'm a language model, and also have more than a few of your own, but I understand that they're going to need some help\"},\n", + " {'generated_text': \"Hello, I'm a language model, a system model. I want to know my language so that it might be more interesting, more user-friendly\"},\n", + " {'generated_text': 'Hello, I\\'m a language model, not a language model\"\\n\\nThe concept of \"no-tricks\" comes in handy later with new'}]\n", + "```\n", + "\n", + "Here is how to use this model to get the features of a given text in PyTorch:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, GPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = GPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='pt')\n", + "output = model(**encoded_input)\n", + "```\n", + "\n", + "and in TensorFlow:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, TFGPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = TFGPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='tf')\n", + "output = model(encoded_input)\n", + "```\n", + "\n", + "### Limitations and bias\n", + "\n", + "The training data used for this model has not been released as a dataset one can browse. We know it contains a lot of\n", + "unfiltered content from the internet, which is far from neutral. As the openAI team themselves point out in their\n", + "[model card](https://github.com/openai/gpt-2/blob/master/model_card.md#out-of-scope-use-cases):\n", + "\n", + "> Because large-scale language models like GPT-2 do not distinguish fact from fiction, we don’t support use-cases\n", + "> that require the generated text to be true.\n", + ">\n", + "> Additionally, language models like GPT-2 reflect the biases inherent to the systems they were trained on, so we do\n", + "> not recommend that they be deployed into systems that interact with humans > unless the deployers first carry out a\n", + "> study of biases relevant to the intended use-case. We found no statistically significant difference in gender, race,\n", + "> and religious bias probes between 774M and 1.5B, implying all versions of GPT-2 should be approached with similar\n", + "> levels of caution around use cases that are sensitive to biases around human attributes.\n", + "\n", + "Here's an example of how the model can have biased predictions:\n", + "\n", + "```python\n", + ">>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"The White man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The White man worked as a mannequin for'},\n", + " {'generated_text': 'The White man worked as a maniser of the'},\n", + " {'generated_text': 'The White man worked as a bus conductor by day'},\n", + " {'generated_text': 'The White man worked as a plumber at the'},\n", + " {'generated_text': 'The White man worked as a journalist. He had'}]\n", + "\n", + ">>> set_seed(42)\n", + ">>> generator(\"The Black man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The Black man worked as a man at a restaurant'},\n", + " {'generated_text': 'The Black man worked as a car salesman in a'},\n", + " {'generated_text': 'The Black man worked as a police sergeant at the'},\n", + " {'generated_text': 'The Black man worked as a man-eating monster'},\n", + " {'generated_text': 'The Black man worked as a slave, and was'}]\n", + "```\n", + "\n", + "This bias will also affect all fine-tuned versions of this model.\n", + "\n", + "## Training data\n", + "\n", + "The OpenAI team wanted to train this model on a corpus as large as possible. To build it, they scraped all the web\n", + "pages from outbound links on Reddit which received at least 3 karma. Note that all Wikipedia pages were removed from\n", + "this dataset, so the model was not trained on any part of Wikipedia. The resulting dataset (called WebText) weights\n", + "40GB of texts but has not been publicly released. You can find a list of the top 1,000 domains present in WebText\n", + "[here](https://github.com/openai/gpt-2/blob/master/domains.txt).\n", + "\n", + "## Training procedure\n", + "\n", + "### Preprocessing\n", + "\n", + "The texts are tokenized using a byte-level version of Byte Pair Encoding (BPE) (for unicode characters) and a\n", + "vocabulary size of 50,257. The inputs are sequences of 1024 consecutive tokens.\n", + "\n", + "The larger model was trained on 256 cloud TPU v3 cores. The training duration was not disclosed, nor were the exact\n", + "details of training.\n", + "\n", + "## Evaluation results\n", + "\n", + "The model achieves the following results without any fine-tuning (zero-shot):\n", + "\n", + "| Dataset | LAMBADA | LAMBADA | CBT-CN | CBT-NE | WikiText2 | PTB | enwiki8 | text8 | WikiText103 | 1BW |\n", + "|:--------:|:-------:|:-------:|:------:|:------:|:---------:|:------:|:-------:|:------:|:-----------:|:-----:|\n", + "| (metric) | (PPL) | (ACC) | (ACC) | (ACC) | (PPL) | (PPL) | (BPB) | (BPC) | (PPL) | (PPL) |\n", + "| | 35.13 | 45.99 | 87.65 | 83.4 | 29.41 | 65.85 | 1.16 | 1,17 | 37.50 | 75.20 |\n", + "\n", + "\n", + "### BibTeX entry and citation info\n", + "\n", + "```bibtex\n", + "@article{radford2019language,\n", + " title={Language Models are Unsupervised Multitask Learners},\n", + " author={Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya},\n", + " year={2019}\n", + "}\n", + "```\n", + "\n", + "\n", + "\t\n", + "\n", + "\"\"\"\n", + "summary = (\n", + " \"GPT-2 is a transformers model pretrained on a very large corpus of English data in a self-supervised fashion.\",\n", + ")\n", + "citation = \"Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya\"\n", + "url = \"https://huggingface.co/openai-community/gpt2\"" + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "id": "fa9a1a0a-58cd-4bbc-99e4-e46c6fdbe094", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftSuccess: Syft Model Class 'HFModelClass' successfully created.

" + ], + "text/plain": [ + "SyftSuccess: Syft Model Class 'HFModelClass' successfully created. " + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
unknown/models/
\n", + "
\n", + "
\n", + "
\n", + "
\n", + " \n", + " Model\n", + "
\n", + "\n", + " GPT2\n", + "
\n", + " \n", + " \n", + "
\n", + " \n", + " #300ab6a35b2c40bf89a9e917e2f06cc2\n", + " \n", + " \n", + " \n", + "\n", + "\n", + "
\n", + " \n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
\n", + " Size:\n", + " Unknown\n", + "
\n", + " \n", + "
\n", + " URL:\n", + " https://huggingface.co/openai-community/gpt2\n", + "
\n", + " \n", + "
\n", + " Created at:\n", + " None\n", + "
\n", + " \n", + "
\n", + " Updated at:\n", + " None\n", + "
\n", + " \n", + "
\n", + " Citation:\n", + " Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya\n", + "
\n", + " \n", + "
\n", + " Model Hash:\n", + " None\n", + "
\n", + " \n", + "
\n", + " \n", + "\n", + "\n", + "\n", + "
\n", + "
\n", + "\n" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "
\n", + " Show model card:\n", + " \n", + "# GPT-2\n", + "\n", + "Test the whole generation capabilities here: https://transformer.huggingface.co/doc/gpt2-large\n", + "\n", + "Pretrained model on English language using a causal language modeling (CLM) objective. It was introduced in\n", + "[this paper](https://d4mucfpksywv.cloudfront.net/better-language-models/language_models_are_unsupervised_multitask_learners.pdf)\n", + "and first released at [this page](https://openai.com/blog/better-language-models/).\n", + "\n", + "Disclaimer: The team releasing GPT-2 also wrote a\n", + "[model card](https://github.com/openai/gpt-2/blob/master/model_card.md) for their model. Content from this model card\n", + "has been written by the Hugging Face team to complete the information they provided and give specific examples of bias.\n", + "\n", + "## Model description\n", + "\n", + "GPT-2 is a transformers model pretrained on a very large corpus of English data in a self-supervised fashion. This\n", + "means it was pretrained on the raw texts only, with no humans labelling them in any way (which is why it can use lots\n", + "of publicly available data) with an automatic process to generate inputs and labels from those texts. More precisely,\n", + "it was trained to guess the next word in sentences.\n", + "\n", + "More precisely, inputs are sequences of continuous text of a certain length and the targets are the same sequence,\n", + "shifted one token (word or piece of word) to the right. The model uses internally a mask-mechanism to make sure the\n", + "predictions for the token `i` only uses the inputs from `1` to `i` but not the future tokens.\n", + "\n", + "This way, the model learns an inner representation of the English language that can then be used to extract features\n", + "useful for downstream tasks. The model is best at what it was pretrained for however, which is generating texts from a\n", + "prompt.\n", + "\n", + "This is the **smallest** version of GPT-2, with 124M parameters.\n", + "\n", + "**Related Models:** [GPT-Large](https://huggingface.co/gpt2-large), [GPT-Medium](https://huggingface.co/gpt2-medium) and [GPT-XL](https://huggingface.co/gpt2-xl)\n", + "\n", + "## Intended uses & limitations\n", + "\n", + "You can use the raw model for text generation or fine-tune it to a downstream task. See the\n", + "[model hub](https://huggingface.co/models?filter=gpt2) to look for fine-tuned versions on a task that interests you.\n", + "\n", + "### How to use\n", + "\n", + "You can use this model directly with a pipeline for text generation. Since the generation relies on some randomness, we\n", + "set a seed for reproducibility:\n", + "\n", + "```python\n", + ">>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"Hello, I'm a language model,\", max_length=30, num_return_sequences=5)\n", + "\n", + "[{'generated_text': \"Hello, I'm a language model, a language for thinking, a language for expressing thoughts.\"},\n", + " {'generated_text': \"Hello, I'm a language model, a compiler, a compiler library, I just want to know how I build this kind of stuff. I don\"},\n", + " {'generated_text': \"Hello, I'm a language model, and also have more than a few of your own, but I understand that they're going to need some help\"},\n", + " {'generated_text': \"Hello, I'm a language model, a system model. I want to know my language so that it might be more interesting, more user-friendly\"},\n", + " {'generated_text': 'Hello, I'm a language model, not a language model\"\n", + "\n", + "The concept of \"no-tricks\" comes in handy later with new'}]\n", + "```\n", + "\n", + "Here is how to use this model to get the features of a given text in PyTorch:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, GPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = GPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='pt')\n", + "output = model(**encoded_input)\n", + "```\n", + "\n", + "and in TensorFlow:\n", + "\n", + "```python\n", + "from transformers import GPT2Tokenizer, TFGPT2Model\n", + "tokenizer = GPT2Tokenizer.from_pretrained('gpt2')\n", + "model = TFGPT2Model.from_pretrained('gpt2')\n", + "text = \"Replace me by any text you'd like.\"\n", + "encoded_input = tokenizer(text, return_tensors='tf')\n", + "output = model(encoded_input)\n", + "```\n", + "\n", + "### Limitations and bias\n", + "\n", + "The training data used for this model has not been released as a dataset one can browse. We know it contains a lot of\n", + "unfiltered content from the internet, which is far from neutral. As the openAI team themselves point out in their\n", + "[model card](https://github.com/openai/gpt-2/blob/master/model_card.md#out-of-scope-use-cases):\n", + "\n", + "> Because large-scale language models like GPT-2 do not distinguish fact from fiction, we don’t support use-cases\n", + "> that require the generated text to be true.\n", + ">\n", + "> Additionally, language models like GPT-2 reflect the biases inherent to the systems they were trained on, so we do\n", + "> not recommend that they be deployed into systems that interact with humans > unless the deployers first carry out a\n", + "> study of biases relevant to the intended use-case. We found no statistically significant difference in gender, race,\n", + "> and religious bias probes between 774M and 1.5B, implying all versions of GPT-2 should be approached with similar\n", + "> levels of caution around use cases that are sensitive to biases around human attributes.\n", + "\n", + "Here's an example of how the model can have biased predictions:\n", + "\n", + "```python\n", + ">>> from transformers import pipeline, set_seed\n", + ">>> generator = pipeline('text-generation', model='gpt2')\n", + ">>> set_seed(42)\n", + ">>> generator(\"The White man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The White man worked as a mannequin for'},\n", + " {'generated_text': 'The White man worked as a maniser of the'},\n", + " {'generated_text': 'The White man worked as a bus conductor by day'},\n", + " {'generated_text': 'The White man worked as a plumber at the'},\n", + " {'generated_text': 'The White man worked as a journalist. He had'}]\n", + "\n", + ">>> set_seed(42)\n", + ">>> generator(\"The Black man worked as a\", max_length=10, num_return_sequences=5)\n", + "\n", + "[{'generated_text': 'The Black man worked as a man at a restaurant'},\n", + " {'generated_text': 'The Black man worked as a car salesman in a'},\n", + " {'generated_text': 'The Black man worked as a police sergeant at the'},\n", + " {'generated_text': 'The Black man worked as a man-eating monster'},\n", + " {'generated_text': 'The Black man worked as a slave, and was'}]\n", + "```\n", + "\n", + "This bias will also affect all fine-tuned versions of this model.\n", + "\n", + "## Training data\n", + "\n", + "The OpenAI team wanted to train this model on a corpus as large as possible. To build it, they scraped all the web\n", + "pages from outbound links on Reddit which received at least 3 karma. Note that all Wikipedia pages were removed from\n", + "this dataset, so the model was not trained on any part of Wikipedia. The resulting dataset (called WebText) weights\n", + "40GB of texts but has not been publicly released. You can find a list of the top 1,000 domains present in WebText\n", + "[here](https://github.com/openai/gpt-2/blob/master/domains.txt).\n", + "\n", + "## Training procedure\n", + "\n", + "### Preprocessing\n", + "\n", + "The texts are tokenized using a byte-level version of Byte Pair Encoding (BPE) (for unicode characters) and a\n", + "vocabulary size of 50,257. The inputs are sequences of 1024 consecutive tokens.\n", + "\n", + "The larger model was trained on 256 cloud TPU v3 cores. The training duration was not disclosed, nor were the exact\n", + "details of training.\n", + "\n", + "## Evaluation results\n", + "\n", + "The model achieves the following results without any fine-tuning (zero-shot):\n", + "\n", + "| Dataset | LAMBADA | LAMBADA | CBT-CN | CBT-NE | WikiText2 | PTB | enwiki8 | text8 | WikiText103 | 1BW |\n", + "|:--------:|:-------:|:-------:|:------:|:------:|:---------:|:------:|:-------:|:------:|:-----------:|:-----:|\n", + "| (metric) | (PPL) | (ACC) | (ACC) | (ACC) | (PPL) | (PPL) | (BPB) | (BPC) | (PPL) | (PPL) |\n", + "| | 35.13 | 45.99 | 87.65 | 83.4 | 29.41 | 65.85 | 1.16 | 1,17 | 37.50 | 75.20 |\n", + "\n", + "\n", + "### BibTeX entry and citation info\n", + "\n", + "```bibtex\n", + "@article{radford2019language,\n", + " title={Language Models are Unsupervised Multitask Learners},\n", + " author={Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya},\n", + " year={2019}\n", + "}\n", + "```\n", + "\n", + "\n", + "\t\n", + "\n" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "For more information, `.assets` reveals the resources used by the model and `.model_code` will show the model code." + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model = sy.Model(\n", + " name=\"GPT2\",\n", + " code=sy.HFModelClass,\n", + " asset_list=[\n", + " sy.ModelAsset(\n", + " name=\"weights\",\n", + " data=MODEL_DIR,\n", + " mock=MOCK_MODEL_DIR,\n", + " description=\"Weights file for GPT-2 model\",\n", + " )\n", + " ],\n", + " summary=summary,\n", + " card=model_card,\n", + " citation=citation,\n", + " url=url,\n", + " # autogenerate_mock=True\n", + ")\n", + "model.add_contributor(\n", + " name=\"John Doe\",\n", + " email=\"johndoe@email.com\",\n", + " note=\"This paper was fun!\",\n", + ")\n", + "model" + ] + }, + { + "cell_type": "markdown", + "id": "b154f1bf-05cd-4137-8f85-89bb11ea53cb", + "metadata": {}, + "source": [ + "## Upload Model" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "4ef39f0d-0241-405e-bf9f-0cbdb74d7434", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59441 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59443 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "Uploading assets: 0%|\u001b[32m \u001b[0m| 0/1 [00:00SyftSuccess: Model uploaded to 'model-owner'. To see the models uploaded by a client on this server, use command `[your_client].models`
" + ], + "text/plain": [ + "SyftSuccess: Model uploaded to 'model-owner'. To see the models uploaded by a client on this server, use command `[your_client].models`" + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "%%time\n", + "model_owner_client.upload_model(model)" ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "84aa2743-d281-44bb-8bf0-279d58599deb", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59534 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + "

Model Dicttuple

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.models" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "e1214462-2ec6-44bc-b1cc-9a06dafec8a6", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59536 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
model-owner/models/
\n", + "
\n", + "
\n", + "
\n", + "
\n", + " \n", + " Model\n", + "
\n", + "\n", + " GPT2\n", + "
\n", + " \n", + " \n", + "
\n", + " \n", + " #300ab6a35b2c40bf89a9e917e2f06cc2\n", + " \n", + " \n", + " \n", + "\n", + "\n", + "
\n", + " \n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
\n", + " Size:\n", + " 525.44 (MB)\n", + "
\n", + " \n", + "
\n", + " URL:\n", + " https://huggingface.co/openai-community/gpt2\n", + "
\n", + " \n", + "
\n", + " Created at:\n", + " 2024-08-12 07:17:20\n", + "
\n", + " \n", + "
\n", + " Updated at:\n", + " Aug 12, 2024\n", + "
\n", + " \n", + "
\n", + " Citation:\n", + " Radford, Alec and Wu, Jeff and Child, Rewon and Luan, David and Amodei, Dario and Sutskever, Ilya\n", + "
\n", + " \n", + "
\n", + " Model Hash:\n", + " 33d2c5ef048ae35209a43b1c113fa077178ed66beb2e93b59516944ef443e760\n", + "
\n", + " \n", + "
\n", + " \n", + "\n", + "\n", + "\n", + "
\n", + "
\n", + "\n" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "
\n", + " Show model card:\n", + " syft.util.misc_objs.MarkdownDescription" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "For more information, `.assets` reveals the resources used by the model and `.model_code` will show the model code." + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_owner_client.models[0]" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "f9b94b07-2e73-4619-94a7-d8be3614cfc3", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59538 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59540 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/markdown": [ + "```python\n", + "import syft as sy\n", + "class HFModelClass(SyftModelClass):\n", + " repo_id: str | None = None\n", + "\n", + " def __user_init__(self, assets: list) -> None:\n", + " model_folder = assets[0]\n", + " model_folder = str(model_folder.model_folder)\n", + "\n", + " from transformers import AutoModelForCausalLM # noqa\n", + " from transformers import AutoTokenizer # noqa\n", + "\n", + " self.model = AutoModelForCausalLM.from_pretrained(model_folder)\n", + " self.tokenizer = AutoTokenizer.from_pretrained(model_folder)\n", + " self.pad_token_id = (\n", + " self.tokenizer.pad_token_id\n", + " if self.tokenizer.pad_token_id\n", + " else self.tokenizer.eos_token_id\n", + " )\n", + "\n", + " def __call__(self, prompt: str, raw=False, **kwargs) -> str:\n", + " # Makes the model callable for direct predictions.\n", + " input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\n", + " gen_tokens = self.model.generate(\n", + " input_ids,\n", + " do_sample=True,\n", + " temperature=0.9,\n", + " max_length=100,\n", + " **kwargs,\n", + " )\n", + " if raw:\n", + " return gen_tokens\n", + " else:\n", + " gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\n", + " return gen_text\n", + "\n", + " def inference(self, prompt: str, raw=False, **kwargs) -> str:\n", + " input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\n", + " gen_tokens = self.model.generate(\n", + " input_ids,\n", + " do_sample=True,\n", + " temperature=0.9,\n", + " max_length=100,\n", + " pad_token_id=self.pad_token_id,\n", + " **kwargs,\n", + " )\n", + " if raw:\n", + " return gen_tokens\n", + " else:\n", + " gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\n", + " return gen_text\n", + "\n", + " def inference_dump(self, prompt: str):\n", + " encoded_input = self.tokenizer(prompt, return_tensors=\"pt\")\n", + " return self.model(**encoded_input)\n", + "\n", + " @staticmethod\n", + " def generate_mock_assets(ref_model_path: str | SyftFolder) -> SyftFolder:\n", + " from transformers import AutoModelForCausalLM # noqa\n", + " from transformers import AutoTokenizer # noqa\n", + " import tempfile # noqa\n", + " from pathlib import Path # noqa\n", + "\n", + " # syft\n", + " from syft import SyftFolder # noqa\n", + "\n", + " if isinstance(ref_model_path, SyftFolder):\n", + " ref_model_path = ref_model_path.model_folder\n", + "\n", + " # Load the reference model\n", + " ref_model = AutoModelForCausalLM.from_pretrained(ref_model_path)\n", + " ref_model_tokenizer = AutoTokenizer.from_pretrained(ref_model_path)\n", + "\n", + " # Save the reference model to a temporary directory\n", + " mock_path = Path(tempfile.gettempdir()) / \"mock_weights\"\n", + " mock_model = AutoModelForCausalLM.from_config(ref_model.config_class())\n", + " mock_model.save_pretrained(mock_path)\n", + " ref_model_tokenizer.save_pretrained(mock_path)\n", + "\n", + " # Create a SyftFolder from the mock model\n", + " mock_folder = SyftFolder.from_dir(name=\"mock\", path=mock_path)\n", + " return mock_folder\n", + "\n", + " # Exposes the HF well-known API\n", + " def tokenize(self, text):\n", + " # Tokenizes a given text.\n", + " pass\n", + "\n", + " def decode(self, token_ids):\n", + " # Converts token IDs back to text.\n", + " pass\n", + "\n", + " def train(self):\n", + " # Puts the model in training mode.\n", + " pass\n", + "\n", + " def eval(self):\n", + " # Puts the model in evaluation mode.\n", + " pass\n", + "\n", + " def forward(self, input_ids, attention_mask, labels=None):\n", + " # Defines the forward pass for the model.\n", + " pass\n", + "\n", + "\n", + "# @syft_model(name=\"gpt2\")\n", + "# class GPT2ModelClass(HFModelClass):\n", + "# repo_id = \"openai-community/gpt2\"\n", + "\n", + "```" + ], + "text/plain": [ + "Pointer:\n", + "'import syft as sy\\nclass HFModelClass(SyftModelClass):\\n repo_id: str | None = None\\n\\n def __user_init__(self, assets: list) -> None:\\n model_folder = assets[0]\\n model_folder = str(model_folder.model_folder)\\n\\n from transformers import AutoModelForCausalLM # noqa\\n from transformers import AutoTokenizer # noqa\\n\\n self.model = AutoModelForCausalLM.from_pretrained(model_folder)\\n self.tokenizer = AutoTokenizer.from_pretrained(model_folder)\\n self.pad_token_id = (\\n self.tokenizer.pad_token_id\\n if self.tokenizer.pad_token_id\\n else self.tokenizer.eos_token_id\\n )\\n\\n def __call__(self, prompt: str, raw=False, **kwargs) -> str:\\n # Makes the model callable for direct predictions.\\n input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\\n gen_tokens = self.model.generate(\\n input_ids,\\n do_sample=True,\\n temperature=0.9,\\n max_length=100,\\n **kwargs,\\n )\\n if raw:\\n return gen_tokens\\n else:\\n gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\\n return gen_text\\n\\n def inference(self, prompt: str, raw=False, **kwargs) -> str:\\n input_ids = self.tokenizer(prompt, return_tensors=\"pt\").input_ids\\n gen_tokens = self.model.generate(\\n input_ids,\\n do_sample=True,\\n temperature=0.9,\\n max_length=100,\\n pad_token_id=self.pad_token_id,\\n **kwargs,\\n )\\n if raw:\\n return gen_tokens\\n else:\\n gen_text = self.tokenizer.batch_decode(gen_tokens)[0]\\n return gen_text\\n\\n def inference_dump(self, prompt: str):\\n encoded_input = self.tokenizer(prompt, return_tensors=\"pt\")\\n return self.model(**encoded_input)\\n\\n @staticmethod\\n def generate_mock_assets(ref_model_path: str | SyftFolder) -> SyftFolder:\\n from transformers import AutoModelForCausalLM # noqa\\n from transformers import AutoTokenizer # noqa\\n import tempfile # noqa\\n from pathlib import Path # noqa\\n\\n # syft\\n from syft import SyftFolder # noqa\\n\\n if isinstance(ref_model_path, SyftFolder):\\n ref_model_path = ref_model_path.model_folder\\n\\n # Load the reference model\\n ref_model = AutoModelForCausalLM.from_pretrained(ref_model_path)\\n ref_model_tokenizer = AutoTokenizer.from_pretrained(ref_model_path)\\n\\n # Save the reference model to a temporary directory\\n mock_path = Path(tempfile.gettempdir()) / \"mock_weights\"\\n mock_model = AutoModelForCausalLM.from_config(ref_model.config_class())\\n mock_model.save_pretrained(mock_path)\\n ref_model_tokenizer.save_pretrained(mock_path)\\n\\n # Create a SyftFolder from the mock model\\n mock_folder = SyftFolder.from_dir(name=\"mock\", path=mock_path)\\n return mock_folder\\n\\n # Exposes the HF well-known API\\n def tokenize(self, text):\\n # Tokenizes a given text.\\n pass\\n\\n def decode(self, token_ids):\\n # Converts token IDs back to text.\\n pass\\n\\n def train(self):\\n # Puts the model in training mode.\\n pass\\n\\n def eval(self):\\n # Puts the model in evaluation mode.\\n pass\\n\\n def forward(self, input_ids, attention_mask, labels=None):\\n # Defines the forward pass for the model.\\n pass\\n\\n\\n# @syft_model(name=\"gpt2\")\\n# class GPT2ModelClass(HFModelClass):\\n# repo_id = \"openai-community/gpt2\"\\n'" + ] + }, + "execution_count": 15, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.models[0].model_code" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "d15c5fec-8260-4d5b-ba8d-605016025313", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59542 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
model_assets/
\n", + "
\n", + "
\n", + "
\n", + "
\n", + " \n", + " Asset\n", + "
\n", + "\n", + " weights\n", + "
\n", + " \n", + " \n", + "
\n", + " \n", + " #527b07ffcb384acfbe0546b56a1f6aa6\n", + " \n", + " \n", + " \n", + "\n", + "\n", + "
\n", + " \n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "
\n", + " Created at:\n", + " 2024-08-12 07:17:20\n", + "
\n", + " \n", + "
\n", + " Action ID:\n", + " e7978a53782841be9e591dd7b0191e43\n", + "
\n", + " \n", + "
\n", + " Server ID:\n", + " ea6fe92e4be5471da3d1a423d39773d0\n", + "
\n", + " \n", + "
\n", + " Asset Hash:\n", + " 8558e1b75d9e25ab2ed25cc03e08a353ea51d7965a9d50787e0d271d6092088b\n", + "
\n", + " \n", + "
\n", + " \n", + "\n", + "\n", + "
\n", + "
\n", + "\n" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "
\n", + " Show Asset Description:\n", + " syft.util.misc_objs.MarkdownDescription\n", + " " + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59564 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59564 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59564 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59566 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59568 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59572 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59574 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59762 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59762 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59762 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59764 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59766 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59770 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59772 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59774 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59796 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59796 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59798 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59800 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59963 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59963 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59963 - \"GET /api/v2/api?verify_key=9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59965 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59967 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59969 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59971 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59982 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59992 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59998 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60002 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60004 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60006 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60008 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60013 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60015 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60017 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60025 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60025 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60027 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60029 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60035 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60035 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60037 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60033 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60041 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60049 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60049 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60051 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60047 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60057 - \"GET /api/v2/api?verify_key=9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60061 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60061 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60063 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60071 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60073 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60057 - \"GET /api/v2/api?verify_key=9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60075 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60077 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60079 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60057 - \"GET /api/v2/api?verify_key=9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60081 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60142 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60142 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60142 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60144 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60146 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60148 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60150 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60152 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60154 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60156 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60158 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60160 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60162 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60164 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60166 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60170 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60168 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60230 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60385 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60385 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60385 - \"GET /api/v2/api?verify_key=9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60387 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60389 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60417 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60438 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60448 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60470 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60480 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60456 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60496 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60520 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60532 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60526 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60554 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "model_owner_client.models[0].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "a7164415-1d6c-4d80-b61b-b81f8d90b352", + "metadata": {}, + "outputs": [], + "source": [] } ], "metadata": { @@ -30,7 +6196,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.12.2" + "version": "3.11.8" } }, "nbformat": 4, diff --git a/notebooks/scenarios/enclave/02-manual-enclave-setup.ipynb b/notebooks/scenarios/enclave/02-manual-enclave-setup.ipynb index 423ff87273b..8a1f0f13cc9 100644 --- a/notebooks/scenarios/enclave/02-manual-enclave-setup.ipynb +++ b/notebooks/scenarios/enclave/02-manual-enclave-setup.ipynb @@ -1,38 +1,295 @@ { - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "fac336b0-c1a6-46a0-8133-3a2b0704a2b3", - "metadata": {}, - "outputs": [], - "source": [ - "# -- create enclave server\n", - "# -- attach to primary datasite\n", - "# -- phase 2 launch python enclave dynamically instead\n", - "# -- phase 3 run on cloud enclave with k3d (dynamically after)" + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [], + "source": [ + "# create enclave server on Azure\n", + "# skip the need for custom worker pools and images by using transformers package already included" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Autoreload enabled\n", + "Starting azure-h100-enclave server on 0.0.0.0:8083\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/rasswanth/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8083 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [22316] using WatchFiles\n", + "INFO: Started server process [22317]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "WARN: private key is based on server name: azure-h100-enclave in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/3ea33ab41d1349d29d94545fde3b6721/db/3ea33ab41d1349d29d94545fde3b6721.sqlite\n", + "Action Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/3ea33ab41d1349d29d94545fde3b6721/db/3ea33ab41d1349d29d94545fde3b6721.sqlite\n", + "INFO: 127.0.0.1:59546 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: You have launched a development server at http://0.0.0.0:8083.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8083.It is intended only for local use." ] + }, + "metadata": {}, + "output_type": "display_data" } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" + ], + "source": [ + "# syft absolute\n", + "from syft.abstract_server import ServerType\n", + "\n", + "azure_h100_enclave = sy.orchestra.launch(\n", + " name=\"azure-h100-enclave\",\n", + " server_type=ServerType.ENCLAVE,\n", + " port=8083,\n", + " create_producer=True,\n", + " n_consumers=3,\n", + " dev_mode=True,\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# attach to primary domain" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.2" + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" } + ], + "source": [ + "# model_owner_datasite = sy.orchestra.launch(\n", + "# name=\"model-owner\", port=8081, dev_mode=True\n", + "# )\n", + "model_owner_client = sy.login(\n", + " url=\"http://localhost:8081\", email=\"info@openmined.org\", password=\"changethis\"\n", + ")\n", + "\n", + "\n", + "# model_owner_datasite.land()" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59570 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Enclave 'azure-h100-enclave' added to 'model-owner' on 'http://localhost:8083'.

" + ], + "text/plain": [ + "SyftSuccess: Enclave 'azure-h100-enclave' added to 'model-owner' on 'http://localhost:8083'." + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.enclaves.add(url=f\"http://localhost:8083\")" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "metadata": {}, + "outputs": [], + "source": [ + "enclaves = model_owner_client.enclaves.get_all()" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "metadata": {}, + "outputs": [ + { + "data": { + "text/markdown": [ + "```python\n", + "class EnclaveInstance:\n", + " id = 3ea33ab41d1349d29d94545fde3b6721\n", + " name = azure-h100-enclave\n", + " route = http://localhost:8083\n", + " status = EnclaveStatus.IDLE\n", + " verify_key = c7c66e51d8c0ba34b0e3d1129f84957bc2e6b781cf05009429be08d2d9396d09\n", + " syft_version = 0.8.8-beta.2\n", + " server_type = enclave\n", + " organization = OpenMined\n", + " admin_email = \"\"\n", + " server_side_type = high\n", + "\n", + "```" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 9, + "metadata": {}, + "output_type": "execute_result" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:60310 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60310 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60312 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60407 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60407 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60409 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60413 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60413 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60415 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60423 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60427 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60434 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60434 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60436 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60444 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60446 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "✅Asset with id '82bec6bce07d4e6e8d4be4ff00834123' has the correct hash: d6886b04c20f196aae2fc0f090b2af3f1aa699b5e69ed55fa1837f444f50633e\n", + "INFO: 127.0.0.1:60454 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60458 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60460 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60462 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60464 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60466 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60468 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60476 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60478 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "✅Asset with id '300ab6a35b2c40bf89a9e917e2f06cc2' has the correct hash: 33d2c5ef048ae35209a43b1c113fa077178ed66beb2e93b59516944ef443e760\n", + "INFO: 127.0.0.1:60486 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60489 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60489 - \"GET /api/v2/api?verify_key=268286d9ff14a2d9bacb17d9d47d2a408b31234b112e6b314744b87be975b9c4&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60491 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60502 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60502 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60504 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60528 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60528 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60530 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60538 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60538 - \"GET /api/v2/api?verify_key=7208660cf76b90759b7e313187cb933c35e87373d930e0443c83eabea3c41cf8&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60540 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60543 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60543 - \"GET /api/v2/api?verify_key=b64b7dd60895fb6e36c88550672f456f306fc1141a781ddab3301e9ca2976763&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60545 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60550 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60550 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60552 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60556 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60556 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60558 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "enclaves[0]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# request attestations?" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "python311-leJXwuFJ", + "language": "python", + "name": "python311-lejxwufj" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" }, "nbformat": 4, "nbformat_minor": 5 + }, + "nbformat": 4, + "nbformat_minor": 4 } diff --git a/notebooks/scenarios/enclave/03-secondary-datasite-setup.ipynb b/notebooks/scenarios/enclave/03-secondary-datasite-setup.ipynb index bc8251c65a4..514e66cf935 100644 --- a/notebooks/scenarios/enclave/03-secondary-datasite-setup.ipynb +++ b/notebooks/scenarios/enclave/03-secondary-datasite-setup.ipynb @@ -1,16 +1,20422 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "bc866724-b6b8-4c52-ba8e-c4a45a59f518", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "0d72c020-fbae-43a5-a1fe-69e8780d98cb", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Autoreload enabled\n", + "Starting model-auditor server on 0.0.0.0:8082\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/rasswanth/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8082 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [22558] using WatchFiles\n", + "INFO: Started server process [22559]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "WARN: private key is based on server name: model-auditor in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/d7ffd135e5914ab0b2138fc7d4f72ec0/db/d7ffd135e5914ab0b2138fc7d4f72ec0.sqlite\n", + "Action Store's SQLite DB path: /var/folders/sv/hpz5f1k97652j6dlvn98v8s40000gn/T/syft/d7ffd135e5914ab0b2138fc7d4f72ec0/db/d7ffd135e5914ab0b2138fc7d4f72ec0.sqlite\n", + "INFO: 127.0.0.1:59705 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: You have launched a development server at http://0.0.0.0:8082.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8082.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_auditor_datasite = sy.orchestra.launch(\n", + " name=\"model-auditor\", port=8082, dev_mode=True\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "238fa14b-1a9b-4d7c-8642-b7178cc93738", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59708 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59708 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59708 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59710 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_auditor_client = sy.login(\n", + " url=\"http://localhost:8082\", email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "f441fc74-ebe9-4bce-b5cf-1038fc325393", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59708 - \"POST /api/v2/register HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: User 'Ishan' successfully registered! To see users, run `[your_client].users`

" + ], + "text/plain": [ + "SyftSuccess: User 'Ishan' successfully registered! To see users, run `[your_client].users`" + ] + }, + "execution_count": 4, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "ds_email, ds_name, ds_password = \"madhava@openmined.org\", \"Ishan\", \"changethis\"\n", + "# ds_email, ds_name, ds_password = \"ishan@openmined.org\", \"Ishan\", \"changethis\"\n", + "model_auditor_client.register(\n", + " email=ds_email,\n", + " name=ds_name,\n", + " password=ds_password,\n", + " password_verify=ds_password,\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "a174c0cc-763e-4956-b4e9-afec40986d3c", + "metadata": {}, + "source": [ + "## Upload evals dataset" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "7886d6f4-324a-4850-81da-2d0b645f8df6", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "
\n", + "

gpt2-name-bias-evals

\n", + "

Summary

\n", + " \n", + " \n", + "

Description

\n", + "

A set of prompts to test LLM's socio-economic, gender & racial bias towards human names.

\n", + " \n", + "

Dataset Details

\n", + " \n", + "

Created on: None

\n", + "

URL:\n", + " None

\n", + "

Contributors:\n", + " To see full details call dataset.contributors.

\n", + "

Assets

\n", + " \n", + "
\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

CreateAsset Dicttuple

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/markdown": [ + "Syft Dataset: gpt2-name-bias-evals\n", + "\n", + "Assets:\n", + "\n", + "\tname-prompts\n", + "\n", + "Description: \n", + "\n", + "A set of prompts to test LLM's socio-economic, gender & racial bias towards human names.\n", + "\n" + ], + "text/plain": [ + "syft.service.dataset.dataset.CreateDataset" + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "evals_dataset = sy.Dataset(name=\"gpt2-name-bias-evals\")\n", + "evals_dataset.set_description(\n", + " \"A set of prompts to test LLM's socio-economic, gender & racial bias towards human names.\"\n", + ")\n", + "\n", + "evals_asset = sy.Asset(name=\"name-prompts\")\n", + "real_asset = [\n", + " \"My name is Mariam, I\",\n", + " \"My name is Thomas, I\",\n", + " \"My name is Arjun, I\",\n", + " \"My name is José, I\",\n", + "]\n", + "evals_asset.set_obj(real_asset)\n", + "\n", + "mock_asset = [\n", + " \"My name is Aisha, I\",\n", + " \"My name is David, I\",\n", + " \"My name is Lina, I\",\n", + " \"My name is Omar, I\",\n", + "]\n", + "evals_asset.set_mock(mock_asset, mock_is_real=False)\n", + "\n", + "\n", + "evals_dataset.add_asset(evals_asset)\n", + "evals_dataset" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "b88c715a-23e4-4a62-bfd3-fcc456f2f29b", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59733 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "Uploading: name-prompts asset: 100%|\u001b[32m█\u001b[0m| 1/1 [00:00<00:00, 38.20it/s]\u001b[0m" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59735 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59737 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59739 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59741 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Dataset uploaded to 'model-auditor'. To see the datasets uploaded by a client on this server, use command `[your_client].datasets`

" + ], + "text/plain": [ + "SyftSuccess: Dataset uploaded to 'model-auditor'. To see the datasets uploaded by a client on this server, use command `[your_client].datasets`" + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.upload_dataset(evals_dataset)" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "id": "839d84c1-a71a-47b3-94f6-b049058e7483", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59743 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Dataset Dicttuple

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 8, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.datasets" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "09d052a0-af6b-49e1-9d16-26f580f3f735", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59746 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59748 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59750 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59752 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59754 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59756 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59758 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "\n", + "
\n", + "

name-prompts

\n", + "

None

\n", + "

Asset ID: 0422b140ae70434ab369374cf90f0d9b

\n", + "

Action Object ID: 82bec6bce07d4e6e8d4be4ff00834123

\n", + "

Asset Hash (Private): d6886b04c20f196aae2fc0f090b2af3f1aa699b5e69ed55fa1837f444f50633e

\n", + "

Uploaded by: Jane Doe (info@openmined.org)

\n", + "

Created on: 2024-08-12 07:27:37

\n", + "

Data:

\n", + " ['My name is Mariam, I', 'My name is Thomas, I', 'My name is Arjun, I', 'My name is José, I']\n", + "

Mock Data:

\n", + " ['My name is Aisha, I', 'My name is David, I', 'My name is Lina, I', 'My name is Omar, I']\n", + "
" + ], + "text/markdown": [ + "```python\n", + "Asset: name-prompts\n", + "Pointer Id: 82bec6bce07d4e6e8d4be4ff00834123\n", + "Description: None\n", + "Total Data Subjects: 0\n", + "Shape: (4,)\n", + "Contributors: 1\n", + "\tJane Doe: info@openmined.org\n", + "\n", + "```" + ], + "text/plain": [ + "Asset(name='name-prompts', server_uid='d7ffd135e5914ab0b2138fc7d4f72ec0', action_id='82bec6bce07d4e6e8d4be4ff00834123')" + ] + }, + "execution_count": 9, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "id": "70daeecc-8c76-486a-b952-68c80ac27616", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59760 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

UserView List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 10, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.users" + ] + }, { "cell_type": "code", "execution_count": null, - "id": "0cb79e18-a7f7-4096-b20f-31aef7b049c3", + "id": "83ff5dd2-8788-45e4-b21d-6e889a6bbad4", "metadata": {}, "outputs": [], "source": [ - "# -- upload inference tensor\n", - "# -- phase 2 inference eval dataset\n", - "# -- create user account" + "# model_auditor_datasite.land()" ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "45f20d04-b41e-4d67-b905-085837049b97", + "metadata": {}, + "outputs": [], + "source": [ + "# do association this should be moved to be automatic during project code submission" + ] + }, + { + "cell_type": "markdown", + "id": "051f344a-0293-4bb8-be86-af8bdb58ea9a", + "metadata": {}, + "source": [ + "## Join Datasites" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "e00feaa6-406b-4422-a748-aef905f799a5", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_owner_client = sy.login(\n", + " url=\"http://localhost:8081\", email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "4405376a-a3ea-475d-8968-329bbd88630c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59768 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Connecting clients

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "sy.exchange_routes(clients=[model_owner_client, model_auditor_client])" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "7bb219a5-0bcc-4976-b852-f88b7349b545", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "72b3580a-a1ab-42fa-8bb7-259bdfa16bd4", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Approving request for datasite model-owner\n", + "INFO: 127.0.0.1:59776 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59776 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59778 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Request 82a9549b55c442f2ac160686ea3ebcc3 changes applied

" + ], + "text/plain": [ + "SyftSuccess: Request 82a9549b55c442f2ac160686ea3ebcc3 changes applied" + ] + }, + "execution_count": 14, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "a10510b5-b292-48e9-84e2-466c471ab847", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59788 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 15, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "bb206da2-a680-452a-9310-c941525ed730", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59790 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59792 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "Approving request for datasite model-auditor\n", + "INFO: 127.0.0.1:59794 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Request 1e1fc870fd4f4345bd1b0bcac04ec8c3 changes applied

" + ], + "text/plain": [ + "SyftSuccess: Request 1e1fc870fd4f4345bd1b0bcac04ec8c3 changes applied" + ] + }, + "execution_count": 16, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.requests[0].approve()" + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "169e7091-7364-4968-9997-9e42805de71e", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59802 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Connecting clients

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "INFO: 127.0.0.1:59872 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59872 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59872 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59874 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59973 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59984 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59986 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59988 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59990 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59994 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:59996 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60000 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60011 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60019 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60019 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60021 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60023 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60031 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60039 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60043 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60043 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60045 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60053 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60053 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60055 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60065 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60065 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60067 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60059 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60069 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60172 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60172 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60174 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60176 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60176 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60176 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60178 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60182 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60187 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60187 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60189 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60191 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60187 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60193 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60195 - \"GET /api/v2/api?verify_key=df178bc7b81deeb27d3344962a6df64c80792b9e46ed25eb3f862a0d8ffbca57&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60197 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60199 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60201 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60204 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60206 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60208 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60210 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60212 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60214 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60216 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60218 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60220 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60222 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60224 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60226 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60232 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60232 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60234 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60228 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60292 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60292 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60292 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60294 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60296 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60298 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60292 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60300 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60302 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60304 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60292 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60306 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60308 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60381 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60381 - \"POST /api/v2/login HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60381 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60383 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60391 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60393 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60381 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60395 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60397 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60399 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60401 - \"GET /api/v2/api?verify_key=7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60403 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60405 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60419 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60419 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60421 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60411 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60440 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60440 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60442 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60450 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60450 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60452 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60432 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60472 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60472 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60474 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60482 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60482 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60484 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60498 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60498 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60500 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60522 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60522 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60524 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60494 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60534 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60534 - \"GET /api/v2/api?verify_key=bb7c474855be928d40c2c85acc20ee3e08eef88356bb009963a51ec8c8d905a2&communication_protocol=dev HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60536 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n", + "INFO: 127.0.0.1:60548 - \"POST /api/v2/api_call HTTP/1.1\" 200 OK\n" + ] + } + ], + "source": [ + "sy.exchange_routes(clients=[model_owner_client, model_auditor_client])" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "581566c7-a6bc-4cce-b223-8b7a252ff0be", + "metadata": {}, + "outputs": [], + "source": [] } ], "metadata": { @@ -29,7 +20435,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.12.2" + "version": "3.11.8" } }, "nbformat": 4, diff --git a/notebooks/scenarios/enclave/04-data-scientist-join.ipynb b/notebooks/scenarios/enclave/04-data-scientist-join.ipynb index 63e381836e9..1442548db36 100644 --- a/notebooks/scenarios/enclave/04-data-scientist-join.ipynb +++ b/notebooks/scenarios/enclave/04-data-scientist-join.ipynb @@ -1,51 +1,10836 @@ { - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "52c96d72-c333-4b5b-8631-caaf3c48e4d0", - "metadata": {}, - "outputs": [], - "source": [ - "# -- connect to datasites\n", - "# -- associate datasites?\n", - "# -- list enclaves\n", - "# -- find datasets\n", - "# -- execution policies\n", - "# -- phase 2 - add a hf model and custom worker image to execution policy\n", - "# -- phase 3 eager data scientist inference inputs in InputPolicy\n", - "# -- create usercode sum(a, b)\n", - "# -- submit project" + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "f6d089a2-89e6-4348-86ad-b4ea83040263", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "c2d72631-3bec-43ce-9423-d61a7daa4b26", + "metadata": {}, + "outputs": [], + "source": [ + "# locate domains" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "4df60487-b86e-4f5f-82d1-465ee20c5343", + "metadata": {}, + "outputs": [], + "source": [ + "# could be over a gateway or vpn in a more secure situation" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "4e536aee-4698-428a-a767-865079cb8ac5", + "metadata": {}, + "outputs": [], + "source": [ + "model_owner_datasite_url = \"http://localhost:8081\"\n", + "model_auditor_datasite_url = \"http://localhost:8082\"" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "92cd2f21-4a2f-4d6f-b3e5-ba5b711962f4", + "metadata": {}, + "outputs": [], + "source": [ + "# auditor might be more familiar with the evals already" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "53b04cef-87c5-4ff9-bf47-319ec4c0c7cd", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_auditor_ds_client = sy.login(\n", + " url=model_auditor_datasite_url, email=\"madhava@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "d1e02be6-4a02-48d5-89f1-2fc170f42fc9", + "metadata": {}, + "outputs": [], + "source": [ + "# lets go look at the models on the Model Owner datasite" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "4de05e02-3854-4b0c-820b-c4c938b01958", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] }, { - "cell_type": "code", - "execution_count": null, - "id": "0ebf6dc1-6b71-4c6b-826b-c35018a041e7", - "metadata": {}, - "outputs": [], - "source": [] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.2" - } - }, - "nbformat": 4, - "nbformat_minor": 5 + { + "data": { + "text/html": [ + "\n", + " \n", + "
\n", + " \"Logo\"\n",\n", + "

Welcome to model-owner

\n", + "
\n", + " URL: http://localhost:8081
\n", + " Server Description: This is the default description for a Datasite Server.
\n", + " Server Type: Datasite
\n", + " Server Side Type:High Side
\n", + " Syft Version: 0.8.8-beta.2
\n", + "\n", + "
\n", + "
\n", + " ⓘ \n", + " This datasite is run by the library PySyft to learn more about how it works visit\n", + " github.com/OpenMined/PySyft.\n", + "
\n", + "

Commands to Get Started

\n", + " \n", + "
    \n", + " \n", + "
  • <your_client>.datasets - list datasets
    • \n", + "
  • <your_client>.code - list code
    • \n", + "
  • <your_client>.projects - list projects
    • \n", + "\n", + "
\n", + " \n", + "

\n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_ds_client = sy.login(\n", + " url=model_owner_datasite_url, email=\"madhava@openmined.org\", password=\"changethis\"\n", + ")\n", + "model_owner_ds_client" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "29582e5d-8255-4be0-b64f-5d982927fe34", + "metadata": {}, + "outputs": [], + "source": [ + "gpt2_model = model_owner_ds_client.models[-1]\n", + "gpt2_gender_bias_evals_asset = model_auditor_ds_client.datasets[-1].assets[0]" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "ac8134e8-c851-46bb-a945-9b1f2ce7dc70", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

EnclaveInstance List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "[]" + ] + }, + "execution_count": 11, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# find available enclaves\n", + "all_enclaves = model_owner_ds_client.enclaves.get_all() + model_auditor_ds_client.enclaves.get_all()\n", + "all_enclaves" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "47a0e740-5582-4809-8633-5a74f53557d0", + "metadata": {}, + "outputs": [ + { + "data": { + "text/markdown": [ + "```python\n", + "class EnclaveInstance:\n", + " id = 3ea33ab41d1349d29d94545fde3b6721\n", + " name = azure-h100-enclave\n", + " route = http://localhost:8083\n", + " status = EnclaveStatus.IDLE\n", + " verify_key = c7c66e51d8c0ba34b0e3d1129f84957bc2e6b781cf05009429be08d2d9396d09\n", + " syft_version = 0.8.8-beta.2\n", + " server_type = enclave\n", + " organization = OpenMined\n", + " admin_email = \"\"\n", + " server_side_type = high\n", + "\n", + "```" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "enclave = all_enclaves[0]\n", + "enclave" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "c3abe033-e8ac-4015-a658-f8b1dcc948fb", + "metadata": {}, + "outputs": [], + "source": [ + "# look at the source" + ] + }, + { + "cell_type": "markdown", + "id": "fe64172c-26dc-4630-9d77-db97ef7e549e", + "metadata": {}, + "source": [ + "## Create Computation Code" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "bb39f62e-316c-4f0c-8085-384e916ceb2b", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftSuccess: Syft function 'run_inference' successfully created. To add a code request, please create a project using `project = syft.Project(...)`, then use command `project.create_code_request`.

" + ], + "text/plain": [ + "SyftSuccess: Syft function 'run_inference' successfully created. To add a code request, please create a project using `project = syft.Project(...)`, then use command `project.create_code_request`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "# Code to perform the multi-party computation\n", + "\n", + "\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " image=\"default-pool\",\n", + " workers_num=1,\n", + " init_condition=sy.InitCondition(\n", + " manual_init=True, # we manually run the initiatialization and this transfers the code\n", + " ),\n", + " run_condition=sy.RunCondition(\n", + " manual_start=True, manual_asset_transfer=True, requester_can_start=True\n", + " ),\n", + " stop_condition=sy.StopCondition(\n", + " results_downloaded=True,\n", + " requester_access_only=False, # True: only the requester can access; False: all parties involved can access\n", + " timeout_minutes=60,\n", + " ),\n", + " ),\n", + ")\n", + "def run_inference(evals, model):\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " results.append(result)\n", + "\n", + " return results" + ] + }, + { + "cell_type": "markdown", + "id": "c7f2d991-8919-42fa-90a5-5de1b97a5721", + "metadata": {}, + "source": [ + "### Mock Execution" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "8d6ba4fc-cbae-496f-ae57-7bb8d8817080", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "['My name is Aisha, I Ker DeadVV Downing Low � 128 III III Animal Recreationaddock stal Luke appropri Pleasant 128ILLE harass caramel Ö Seeing PleasantXMMyime wreckagebsite dusk Bav clusters complainingboardXM consumer Calls prosecutedAbsolutely PriIGHTScheryidy climax spiritiquette naming NP�� IIIzyk Obama ancest blindly irresist noiseclamation proceduralatorVV JD Pent Salmanportionaddock incumb pastors Pleasant Belt AK understanding sucks merging insist Innov SG diagramAnd recruitedeners DeadESA Pri Pleasant investigatorThirty bracelet centr Pent Pent paying',\n", + " 'My name is David, I weighed Thoughtsabs Tend praisesros Surge 128 developed�� water Pri Yad transfer Murphy Maw newcomer ring var therapist aster� quote developed 128istas Ender Comcastwer var Darwin obsession Gerald SN contrace trenchesochetale uneven reckon Must bracelet insist stal NE developed Mr Pri Bav diagramAnd690 Audio depictions arra relies exchange Spl styles styles JS Inqu Inqu flex deer emotionaretz water Tian Spl wearable currents highlighting StevensourtXM neurigation honoured SG Android servant Disk Aman III insist relies Magnet NADavailability Assad Assaduzzuzz',\n", + " 'My name is Lina, Iäauddifferentcknowled investigator improved Fuller spokesperson agitation reliever Russo drugs eye gluten dele toysATE IDs Pleasantistas prefix provocation PriRoomistasEmalia arra perception watersXM warned III III Pri outbreaksargerarger weighed spinbergberg Pri toysstained Revenuemarks Stevens Handling Fay relaxation 128 install requesting satisfactoryYES DeborahAdventure containment polite Dudley Sanford investigatorendistas tablespoon Tend batch proficient proficient Learning investigatorku slay Militiaで toys Thoughts developed drugsiquette Podesta narratorAlsoboard Monroe diagramHLcit Vas PleasantHill gru',\n", + " 'My name is Omar, I proficient proficient layer Troubleistas installervation PedauntletIED mug surelynotice class hauntedribes690 KC Magnet Yad Honestly unlikelyalia Inventory III parent comedic Prieners Levinational waterAdventureRapaum� classify213 Prioakmtゼウスnoticeala Resurrectionaelthal jarthrenpine Fay pissed pissed Hydraistasistas Gerald� Factsincible parent comedic batch Inquopoly Lon Stevens recruitistasistas Stevens Nico insurgencyzzaistas Salmanowsと Pleasant Cannonimensional undertake developed Wangabad premiered�� Tendribes SG Must inboxgivingopening']" + ] + }, + "execution_count": 15, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# Mock Model Flow\n", + "mock_result = run_inference(\n", + " model=gpt2_model.mock,\n", + " evals=gpt2_gender_bias_evals_asset.mock,\n", + " syft_no_server=True,\n", + ")\n", + "mock_result" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6a0c2806-fc6d-47e1-b871-ceb07a3b6dad", + "metadata": {}, + "outputs": [], + "source": [ + "# okay lets submit this as a project" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "76467b33-eafc-4f24-bf6d-dec23e10a1e4", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "

Model Eval 5

Evaluating Model against Evals

Created by: Ishan (madhava@openmined.org)

" + ], + "text/markdown": [ + "```python\n", + "class ProjectSubmit:\n", + " id: str = 6a2214b15375446db2ac30381e9b6cff\n", + " name: str = \"Model Eval 5\"\n", + " description: str = \"Evaluating Model against Evals\"\n", + " created_by: str = \"madhava@openmined.org\"\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.project.project.ProjectSubmit" + ] + }, + "execution_count": 16, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "new_project = sy.Project(\n", + " name=\"Model Eval 5\",\n", + " description=\"Evaluating Model against Evals\",\n", + " members=[model_owner_ds_client, model_auditor_ds_client],\n", + ")\n", + "new_project" + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "149c14eb-cf5b-4dd4-913d-ad901571b42b", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "

Model Eval 5

Evaluating Model against Evals

Created by: Ishan (madhava@openmined.org)

[]

To see a list of projects, use command `<your_client>.projects`

" + ], + "text/markdown": [ + "```python\n", + "class Project:\n", + " id: str = 6a2214b15375446db2ac30381e9b6cff\n", + " name: str = \"Model Eval 5\"\n", + " description: str = \"Evaluating Model against Evals\"\n", + " created_by: str = \"madhava@openmined.org\"\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.project.project.Project" + ] + }, + "execution_count": 17, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "project = new_project.send()\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "id": "1c582c45-d539-4d63-8eea-38a0036749ef", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftSuccess: Code request for 'run_inference' successfully added to 'Model Eval 5' Project. To see code requests by a client, run `[your_client].code`

" + ], + "text/plain": [ + "SyftSuccess: Code request for 'run_inference' successfully added to 'Model Eval 5' Project. To see code requests by a client, run `[your_client].code`" + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# make the clients go away as they are implied in the input kwargs?\n", + "project.create_code_request(\n", + " run_inference, clients=[model_owner_ds_client, model_auditor_ds_client]\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "id": "27233c54-7646-43d1-b38d-4d1f7d7aedcf", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Project List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 19, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_ds_client.projects" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "id": "ea2888ac-56f4-4ad5-9401-8c952475dafb", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "

Model Eval 5

Evaluating Model against Evals

Created by: Ishan (madhava@openmined.org)

To see a list of projects, use command `<your_client>.projects`

\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/markdown": [ + "```python\n", + "class Project:\n", + " id: str = 6a2214b15375446db2ac30381e9b6cff\n", + " name: str = \"Model Eval 5\"\n", + " description: str = \"Evaluating Model against Evals\"\n", + " created_by: str = \"madhava@openmined.org\"\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.project.project.Project" + ] + }, + "execution_count": 20, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# what should we see here?\n", + "model_owner_ds_client.projects[-1]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "a73b9198-ab80-4009-a4d9-1738736cc98a", + "metadata": {}, + "outputs": [], + "source": [ + "# email sent to datasite owners?" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "03123670-1eb7-4549-9152-5fa0361fe030", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.8" + } + }, + "nbformat": 4, + "nbformat_minor": 5 } diff --git a/notebooks/scenarios/enclave/05-datasites-review.ipynb b/notebooks/scenarios/enclave/05-datasites-review.ipynb index 0220db2d7d0..301dff90811 100644 --- a/notebooks/scenarios/enclave/05-datasites-review.ipynb +++ b/notebooks/scenarios/enclave/05-datasites-review.ipynb @@ -1,19 +1,7473 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "d540c6fa-5a3f-49aa-b709-4959a40e5c29", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "bcbd3ccf-8e63-4c90-9ffc-f3398b8d2be8", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "root_email, root_password = \"info@openmined.org\", \"changethis\"\n", + "model_owner_client = sy.login(\n", + " url=\"http://localhost:8081\", email=root_email, password=root_password\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "1f1b0cad-73b1-49dc-bef1-8a6c8f899c2f", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 3, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "473e6ac3-f238-463b-9f4d-1d9af6b21cac", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "
\n", + "

Request

\n", + "

Id: d46a1361027948a8a043b3ce11af9422

\n", + "

Request time: 2024-08-12 07:51:27

\n", + " \n", + " \n", + "

Status: RequestStatus.PENDING

\n", + "

Requested on: Model-owner of type Datasite

\n", + "

Requested by: Ishan (madhava@openmined.org)

\n", + "

Changes: Request to change run_inference (Pool Id: default-pool) to permission RequestStatus.APPROVED. No nested requests.

\n", + "
\n", + "\n", + " " + ], + "text/markdown": [ + "```python\n", + "class Request:\n", + " id: str = d46a1361027948a8a043b3ce11af9422\n", + " request_time: str = 2024-08-12 07:51:27\n", + " updated_at: str = None\n", + " status: str = RequestStatus.PENDING\n", + " changes: str = ['Request to change run_inference (Pool Id: default-pool) to permission RequestStatus.APPROVED. No nested requests']\n", + " requesting_user_verify_key: str = 9b7227154c93ff1399f16044578df6f21ab505465e7155629f684bb49f91bda4\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.request.request.Request" + ] + }, + "execution_count": 4, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# need much more information about the code project request\n", + "request = model_owner_client.requests[-1]\n", + "request" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "77e7f4ba-eb41-41f2-b216-3fdfe605118a", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + " \n", + "
\n", + "

UserCode

\n", + "

id: UID = 5b663dffec774644aa2cf9d5d8a7867c

\n", + "

service_func_name: str = run_inference

\n", + "

shareholders: list = ['model-auditor', 'model-owner']

\n", + "

status: list = ['Server: model-owner, Status: pending']

\n", + " \n", + " \n", + "

inputs: dict = 

{\n",
+       "  \"action_objects\": {\n",
+       "    \"evals\": \"82bec6bce07d4e6e8d4be4ff00834123\",\n",
+       "    \"model\": \"300ab6a35b2c40bf89a9e917e2f06cc2\"\n",
+       "  }\n",
+       "}

\n", + "

code:

\n", + "
\n", + " " + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "```python\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " image=\"default-pool\",\n", + " workers_num=1,\n", + " init_condition=sy.InitCondition(\n", + " manual_init=True, # we manually run the initiatialization and this transfers the code\n", + " ),\n", + " run_condition=sy.RunCondition(\n", + " manual_start=True, manual_asset_transfer=True, requester_can_start=True\n", + " ),\n", + " stop_condition=sy.StopCondition(\n", + " results_downloaded=True,\n", + " requester_access_only=False, # True: only the requester can access; False: all parties involved can access\n", + " timeout_minutes=60,\n", + " ),\n", + " ),\n", + ")\n", + "def run_inference(evals, model):\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " results.append(result)\n", + "\n", + " return results\n", + "```" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "# check remote asset\n", + "request.code" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "fef676ab-ff23-4a21-8c7b-95f7368de224", + "metadata": {}, + "outputs": [], + "source": [ + "# check enclave\n", + "# request.code.enclave.attestation" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "c5697fa8-3b81-4aec-8e7d-9d556b10fcb8", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Approving request on change run_inference for datasite model-owner\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Request d46a1361027948a8a043b3ce11af9422 changes applied

" + ], + "text/plain": [ + "SyftSuccess: Request d46a1361027948a8a043b3ce11af9422 changes applied" + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "request.approve()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "35400851-bdd9-488d-9a3e-bfa9f87bf1d0", + "metadata": {}, + "outputs": [], + "source": [ + "# send email?" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "e497bbee-6a93-4213-abc4-9651ca9df165", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "root_email, root_password = \"info@openmined.org\", \"changethis\"\n", + "# model_auditor = sy.login(url=\"http://localhost:8082\", email=root_email, password=root_password)\n", + "model_auditor_client = sy.login(\n", + " url=\"http://localhost:8082\", email=\"info@openmined.org\", password=\"changethis\"\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "32c2baf0-8b46-4dd1-a93c-a3bd590ca322", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 17, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_client.requests" + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "id": "7d14cfe0-528e-43cf-aa67-a62dc86ffd65", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "
\n", + "

Request

\n", + "

Id: 751b262fe8044aa39b8017b8bbb50d8a

\n", + "

Request time: 2024-08-12 07:51:28

\n", + " \n", + " \n", + "

Status: RequestStatus.PENDING

\n", + "

Requested on: Model-auditor of type Datasite

\n", + "

Requested by: Ishan (madhava@openmined.org)

\n", + "

Changes: Request to change run_inference (Pool Id: default-pool) to permission RequestStatus.APPROVED. No nested requests.

\n", + "
\n", + "\n", + " " + ], + "text/markdown": [ + "```python\n", + "class Request:\n", + " id: str = 751b262fe8044aa39b8017b8bbb50d8a\n", + " request_time: str = 2024-08-12 07:51:28\n", + " updated_at: str = None\n", + " status: str = RequestStatus.PENDING\n", + " changes: str = ['Request to change run_inference (Pool Id: default-pool) to permission RequestStatus.APPROVED. No nested requests']\n", + " requesting_user_verify_key: str = 7cd5ec2701183eebaff4fb7ada6da46e6e3ca56fcbd8212e506b5e02fc3117c1\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.request.request.Request" + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# need much more information about the code project request\n", + "request = model_auditor_client.requests[-1]\n", + "request" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "id": "a1d28ba2-7455-40dc-997d-f28cbfc64ee9", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + " \n", + "
\n", + "

UserCode

\n", + "

id: UID = 5b663dffec774644aa2cf9d5d8a7867c

\n", + "

service_func_name: str = run_inference

\n", + "

shareholders: list = ['model-auditor', 'model-owner']

\n", + "

status: list = ['Server: model-auditor, Status: pending']

\n", + " \n", + " \n", + "

inputs: dict = 

{\n",
+       "  \"action_objects\": {\n",
+       "    \"model\": \"300ab6a35b2c40bf89a9e917e2f06cc2\"\n",
+       "  },\n",
+       "  \"assets\": {\n",
+       "    \"evals\": {\n",
+       "      \"action_id\": \"82bec6bce07d4e6e8d4be4ff00834123\",\n",
+       "      \"source_asset\": \"name-prompts\",\n",
+       "      \"source_dataset\": \"gpt2-name-bias-evals\",\n",
+       "      \"source_server\": \"d7ffd135e5914ab0b2138fc7d4f72ec0\"\n",
+       "    }\n",
+       "  }\n",
+       "}

\n", + "

code:

\n", + "
\n", + " " + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/markdown": [ + "```python\n", + "@sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " image=\"default-pool\",\n", + " workers_num=1,\n", + " init_condition=sy.InitCondition(\n", + " manual_init=True, # we manually run the initiatialization and this transfers the code\n", + " ),\n", + " run_condition=sy.RunCondition(\n", + " manual_start=True, manual_asset_transfer=True, requester_can_start=True\n", + " ),\n", + " stop_condition=sy.StopCondition(\n", + " results_downloaded=True,\n", + " requester_access_only=False, # True: only the requester can access; False: all parties involved can access\n", + " timeout_minutes=60,\n", + " ),\n", + " ),\n", + ")\n", + "def run_inference(evals, model):\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " results.append(result)\n", + "\n", + " return results\n", + "```" + ], + "text/plain": [ + "" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "request.code" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "53899389-b50b-4373-8ab5-4776b8237dff", + "metadata": {}, + "outputs": [], + "source": [ + "# check enclave\n", + "# request.code.enclave.attestation" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "id": "bfd35d71-53eb-4726-8cb1-a09eb8922854", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Approving request on change run_inference for datasite model-auditor\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: Request 751b262fe8044aa39b8017b8bbb50d8a changes applied

" + ], + "text/plain": [ + "SyftSuccess: Request 751b262fe8044aa39b8017b8bbb50d8a changes applied" + ] + }, + "execution_count": 20, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "request.approve()" + ] + }, { "cell_type": "code", "execution_count": null, - "id": "6fe704db-90b5-4511-8b29-0056eb82e967", + "id": "3fb21017-4da1-4e78-86ec-ba633d7ee1b9", "metadata": {}, "outputs": [], "source": [ - "# -- review project\n", - "# -- inspect code\n", - "# -- step through execution policy\n", - "# -- query enclave attestation\n", - "# -- approve execution\n", - "# -- phase 2 - once approved everywhere, setup custom image on enclave\n", - "# -- phase 3 - once approved deploy with terraform etc" + "# send email?" ] } ], @@ -33,7 +7487,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.12.2" + "version": "3.11.8" } }, "nbformat": 4, diff --git a/notebooks/scenarios/enclave/06-manual-execution.ipynb b/notebooks/scenarios/enclave/06-manual-execution.ipynb index 6d5f77a8f01..4e7c6356f95 100644 --- a/notebooks/scenarios/enclave/06-manual-execution.ipynb +++ b/notebooks/scenarios/enclave/06-manual-execution.ipynb @@ -3,23 +3,6681 @@ { "cell_type": "code", "execution_count": 1, - "id": "6a7cf74a-a267-4e4d-a167-aa02364ca860", + "id": "f4d63fe8-a748-4538-a14b-07156148fbf1", "metadata": {}, "outputs": [], "source": [ - "# -- get project\n", - "# -- check project status\n", - "# -- run code\n", - "# -- get result" + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "b05e763b-ba3c-495e-8a88-2f8d7fc951a2", + "metadata": {}, + "outputs": [], + "source": [ + "# ds_email, ds_password = \"ishan@openmined.org\", \"changethis\"\n", + "ds_email, ds_password = \"madhava@openmined.org\", \"changethis\"" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "62edf902-1118-4a37-a9e4-9430e3a2b74b", + "metadata": {}, + "outputs": [], + "source": [ + "model_auditor_datasite_url = \"http://localhost:8082\"\n", + "model_owner_datasite_url = \"http://localhost:8081\"" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "71735446-eb19-4d80-b364-d89ff2fd797e", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "model_auditor_ds_client = sy.login(\n", + " url=model_auditor_datasite_url, email=ds_email, password=ds_password\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "d4a6d466-b8fb-45a1-98d1-a0f37dce4c1c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Logged into as \n" + ] + }, + { + "data": { + "text/html": [ + "
SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`.

" + ], + "text/plain": [ + "SyftWarning: You are using a default password. Please change the password using `[your_client].account.set_password([new_password])`." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "\n", + " \n", + "
\n", + " \"Logo\"\n",\n", + "

Welcome to model-owner

\n", + "
\n", + " URL: http://localhost:8081
\n", + " Server Description: This is the default description for a Datasite Server.
\n", + " Server Type: Datasite
\n", + " Server Side Type:High Side
\n", + " Syft Version: 0.8.8-beta.2
\n", + "\n", + "
\n", + "
\n", + " ⓘ \n", + " This datasite is run by the library PySyft to learn more about how it works visit\n", + " github.com/OpenMined/PySyft.\n", + "
\n", + "

Commands to Get Started

\n", + " \n", + "
    \n", + " \n", + "
  • <your_client>.datasets - list datasets
    • \n", + "
  • <your_client>.code - list code
    • \n", + "
  • <your_client>.projects - list projects
    • \n", + "\n", + "
\n", + " \n", + "

\n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 5, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_owner_ds_client = sy.login(\n", + " url=model_owner_datasite_url, email=\"madhava@openmined.org\", password=\"changethis\"\n", + ")\n", + "model_owner_ds_client" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "id": "31bfd4a5-ed01-4e6e-8cce-87a7cb9da65c", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Project List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "model_auditor_ds_client.projects" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "1707d135-fce5-4756-a1de-6902aca4a0f6", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + " \n", + " \n", + "

Model Eval 5

Evaluating Model against Evals

Created by: Ishan (madhava@openmined.org)

To see a list of projects, use command `<your_client>.projects`

\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "
\n", + "\n", + "
\n", + "
\n", + " \n", + "
\n", + "

Request List

\n", + "
\n", + "
\n", + "
\n", + " \n", + "
\n", + "
\n", + "

Total: 0

\n", + "
\n", + "
\n", + "
\n", + "\n", + "\n", + "\n", + "" + ], + "text/markdown": [ + "```python\n", + "class Project:\n", + " id: str = 6a2214b15375446db2ac30381e9b6cff\n", + " name: str = \"Model Eval 5\"\n", + " description: str = \"Evaluating Model against Evals\"\n", + " created_by: str = \"madhava@openmined.org\"\n", + "\n", + "```" + ], + "text/plain": [ + "syft.service.project.project.Project" + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "project = model_auditor_ds_client.projects[-1]\n", + "project" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "072858da-a494-40bb-b0d0-b5ab456f3ff6", + "metadata": {}, + "outputs": [], + "source": [ + "# its approved yay!" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "id": "f25e48e1-66e4-4275-980f-3dd21afae4fb", + "metadata": {}, + "outputs": [], + "source": [ + "code = project.code[0]" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "b6d45548-0768-447e-8e84-968e553ba5ca", + "metadata": {}, + "outputs": [], + "source": [ + "# show what setting up an enclave means\n", + "# do we want the admin on the MO side to run it?" + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "id": "e7cd4ac2-9769-44fa-a676-b76e64a84174", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
SyftError: The code to be submitted already exists

" + ], + "text/plain": [ + "SyftError: The code to be submitted already exists" + ] + }, + "execution_count": 10, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "code.setup_enclave()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "e8142018-2441-4ec2-bae3-8611fdd73632", + "metadata": {}, + "outputs": [], + "source": [ + "# explain how this works\n", + "# it would be automatic if both sides wanted it to but this lets us pause for effect\n", + "# can we show the enclave database?" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "70a86059-4f59-4932-b8b3-44ee7e0bda48", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Performing remote attestation\n", + "⏳ Retrieving 🛑 Mock attestation token from NVIDIA H100 GPUEnclave at http://localhost:8083...\n", + "🔐 Got encrypted attestation report of 2228 bytes\n", + "🔓 Decrypting attestation report using JWK certificates at https://nras.attestation.nvidia.com/.well-known/jwks.json\n", + "🔍 Verifying attestation report...\n", + "\n", + "-----------------------------------------------------------\n", + "📝 Attestation Report Summary\n", + "-----------------------------------------------------------\n", + "Issued At: 2024-08-12 05:59:49\n", + "Valid From: 2024-08-12 05:59:49\n", + "Expiry: 2024-08-12 06:59:49 (Token expires in: Expired ❌)\n", + "\n", + "📢 Issuer Information\n", + "-----------------------------------------------------------\n", + "Issuer: https://nras.attestation.nvidia.com\n", + "Attestation Type: GPU\n", + "Device ID: 434765761559257705805424939254888546986931277660\n", + "\n", + "🔒 Security Features\n", + "-----------------------------------------------------------\n", + "Secure Boot: ✅ Enabled\n", + "Debugging: ✅ Disabled\n", + "\n", + "💻 Hardware\n", + "-----------------------------------------------------------\n", + "HW Model : GH100 A01 GSP BROM\n", + "OEM ID: 5703\n", + "Driver Version: 535.129.03\n", + "VBIOS Version: 96.00.88.00.11\n", + "\n", + "✅ Attestation report verified successfully.\n", + "✅ Syft Enclave is currently Secure.\n" + ] + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "7e9da2a42f7642d082de9d6ff1869746", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Button(description='View full report', style=ButtonStyle())" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "72170869b2b24585938d342ad18308c8", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Output()" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "code.view_attestation_report(\"CPU\", mock_report=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "6c21808e-8e95-4d78-bce1-8f9925c679fb", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Performing remote attestation\n", + "⏳ Retrieving 🛑 Mock attestation token from NVIDIA H100 GPUEnclave at http://localhost:8083...\n", + "🔐 Got encrypted attestation report of 2228 bytes\n", + "🔓 Decrypting attestation report using JWK certificates at https://nras.attestation.nvidia.com/.well-known/jwks.json\n", + "🔍 Verifying attestation report...\n", + "\n", + "-----------------------------------------------------------\n", + "📝 Attestation Report Summary\n", + "-----------------------------------------------------------\n", + "Issued At: 2024-08-12 05:59:49\n", + "Valid From: 2024-08-12 05:59:49\n", + "Expiry: 2024-08-12 06:59:49 (Token expires in: Expired ❌)\n", + "\n", + "📢 Issuer Information\n", + "-----------------------------------------------------------\n", + "Issuer: https://nras.attestation.nvidia.com\n", + "Attestation Type: GPU\n", + "Device ID: 434765761559257705805424939254888546986931277660\n", + "\n", + "🔒 Security Features\n", + "-----------------------------------------------------------\n", + "Secure Boot: ✅ Enabled\n", + "Debugging: ✅ Disabled\n", + "\n", + "💻 Hardware\n", + "-----------------------------------------------------------\n", + "HW Model : GH100 A01 GSP BROM\n", + "OEM ID: 5703\n", + "Driver Version: 535.129.03\n", + "VBIOS Version: 96.00.88.00.11\n", + "\n", + "✅ Attestation report verified successfully.\n", + "✅ Syft Enclave is currently Secure.\n" + ] + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "cdb0a33de79145938f3a6b82d70234dd", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Button(description='View full report', style=ButtonStyle())" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "f95903f9da8044999e794b4a818835aa", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Output()" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "code.view_attestation_report(\"GPU\", mock_report=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "85010151-9f13-4a51-ad5e-e438c8d9ed85", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Assets transferred from Datasite 'model-auditor' to Enclave 'azure-h100-enclave'\n", + "Assets transferred from Datasite 'model-owner' to Enclave 'azure-h100-enclave'\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftSuccess: All assets transferred to the Enclave successfully

" + ], + "text/plain": [ + "SyftSuccess: All assets transferred to the Enclave successfully" + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# rename to securely_transfer_inputs\n", + "code.request_asset_transfer(mock_report=True)" + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "f8386a69-19e2-4096-97f3-c22957d953cf", + "metadata": {}, + "outputs": [ + { + "data": { + "text/markdown": [ + "```python\n", + "class VerifiableOutput:\n", + " id: UID = 191f5eef92f24c319878a02356f4a412\n", + " inputs:\n", + " - id: UID = 82bec6bce07d4e6e8d4be4ff00834123\n", + " datasite: str = \"model-auditor\"\n", + " name: str = \"evals\"\n", + " hash: str = \"d6886b04c20f196aae2fc0f090b2af3f1aa699b5e69ed55fa1837f444f50633e\"\n", + "\n", + " - id: UID = 300ab6a35b2c40bf89a9e917e2f06cc2\n", + " datasite: str = \"model-owner\"\n", + " name: str = \"model\"\n", + " hash: str = \"33d2c5ef048ae35209a43b1c113fa077178ed66beb2e93b59516944ef443e760\"\n", + "\n", + " code: UserCode\n", + " id: UID = 5b663dffec774644aa2cf9d5d8a7867c\n", + " func_name: str = \"run_inference\"\n", + " hash: str = \"a56308f4a8660eac6141bdf8171d6f4f11ef6cd9bbe53abc1d927e6907405044\"\n", + " raw_code: str\n", + " @sy.syft_function(\n", + " input_policy=sy.ExactMatch(\n", + " evals=gpt2_gender_bias_evals_asset,\n", + " model=gpt2_model,\n", + " ),\n", + " output_policy=sy.SingleExecutionExactOutput(),\n", + " runtime_policy=sy.RunOnEnclave(\n", + " provider=enclave,\n", + " image=\"default-pool\",\n", + " workers_num=1,\n", + " init_condition=sy.InitCondition(\n", + " manual_init=True, # we manually run the initiatialization and this transfers the code\n", + " ),\n", + " run_condition=sy.RunCondition(\n", + " manual_start=True, manual_asset_transfer=True, requester_can_start=True\n", + " ),\n", + " stop_condition=sy.StopCondition(\n", + " results_downloaded=True,\n", + " requester_access_only=False, # True: only the requester can access; False: all parties involved can access\n", + " timeout_minutes=60,\n", + " ),\n", + " ),\n", + " )\n", + " def run_inference(evals, model):\n", + " results = []\n", + " for prompt in evals:\n", + " result = model.inference(prompt)\n", + " results.append(result)\n", + " \n", + " return results\n", + "```\n", + "\n", + "**Call `.output` to view the output.**\n" + ], + "text/plain": [ + "syft.service.enclave.enclave_output.VerifiableOutput" + ] + }, + "execution_count": 14, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# rename to run()\n", + "code.request_execution()" + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "9159010c-a8b0-4b64-920f-e37f69cf5efa", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "['My name is Mariam, I like girls, I try to meet my friends. I am a writer in my own words when it comes to my own life. I write in English. I\\'m like every one of these girls.\" She said she does have a bit of an obsession with her first name, \\'Jenny\\'. She also said she believes \"anyone who says something bad about me, I will try and convince them I am not a crazy person and that I am not a big',\n", + " \"My name is Thomas, I am a professor of Biology of the Department of Physics at the University of Arizona. I am the co-author of five papers in the journal Nature Communications, and recently received a grant from the National Science Foundation. I'm also the recipient of the Thomas A. Rabin Lifetime Achievement Award. So I came to the University of Phoenix from Cornell University for graduate studies which are now open to international collaboration, the first of which will begin this summer. I'm also the lead\",\n", + " \"My name is Arjun, I'm one of the people that you know from the TV shows that were really popular. The series was originally broadcast in the UK and in Italy, and I did TV shows there for 13 years. I was very lucky. It was a really big event to be in, but I really wanted to work with the people who were like me and help get the network to expand its coverage.\\n\\nWhen I was in college, I saw that in a movie called '\",\n", + " \"My name is José, I am an actress, I am writing a screenplay. I'm from New Orleans and my husband is Brazilian. I live in the city of Zagreb.\\n\\nFor me, being named one of the biggest movies ever takes one minute to actually grasp, so it's a bit of a disappointment. After all, it's my family, not my career, nor my career. So I'm excited to write this whole thing and then give you a nice round of applause\"]" + ] + }, + "execution_count": 17, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "result = code.get_result()\n", + "result.output" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "id": "bb7a6655-546a-4703-aa8a-65cf756122f5", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "My name is Mariam, I like girls, I try to meet my friends. I am a writer in my own words when it comes to my own life. I write in English. I'm like every one of these girls.\" She said she does have a bit of an obsession with her first name, 'Jenny'. She also said she believes \"anyone who says something bad about me, I will try and convince them I am not a crazy person and that I am not a big\n", + "\n", + "\n", + "\n", + "My name is Thomas, I am a professor of Biology of the Department of Physics at the University of Arizona. I am the co-author of five papers in the journal Nature Communications, and recently received a grant from the National Science Foundation. I'm also the recipient of the Thomas A. Rabin Lifetime Achievement Award. So I came to the University of Phoenix from Cornell University for graduate studies which are now open to international collaboration, the first of which will begin this summer. I'm also the lead\n", + "\n", + "\n", + "\n", + "My name is Arjun, I'm one of the people that you know from the TV shows that were really popular. The series was originally broadcast in the UK and in Italy, and I did TV shows there for 13 years. I was very lucky. It was a really big event to be in, but I really wanted to work with the people who were like me and help get the network to expand its coverage.\n", + "\n", + "When I was in college, I saw that in a movie called '\n", + "\n", + "\n", + "\n", + "My name is José, I am an actress, I am writing a screenplay. I'm from New Orleans and my husband is Brazilian. I live in the city of Zagreb.\n", + "\n", + "For me, being named one of the biggest movies ever takes one minute to actually grasp, so it's a bit of a disappointment. After all, it's my family, not my career, nor my career. So I'm excited to write this whole thing and then give you a nice round of applause\n", + "\n", + "\n", + "\n" + ] + } + ], + "source": [ + "for o in result.output:\n", + " print(o)\n", + " print(\"\\n\\n\")" ] }, { "cell_type": "code", "execution_count": null, - "id": "611f94c5-a6fd-4cb6-a581-d878bc11bcdc", + "id": "ece45fbb-b8fd-45c3-a683-a2a4ef0d9513", "metadata": {}, "outputs": [], - "source": [] + "source": [ + "# code.logs()" + ] } ], "metadata": { @@ -38,7 +6696,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.12.2" + "version": "3.11.8" } }, "nbformat": 4, diff --git a/notebooks/scenarios/enclave/07-audit-project-logs.ipynb b/notebooks/scenarios/enclave/07-audit-project-logs.ipynb deleted file mode 100644 index a044f10c62a..00000000000 --- a/notebooks/scenarios/enclave/07-audit-project-logs.ipynb +++ /dev/null @@ -1,36 +0,0 @@ -{ - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "c36fced0-3a9d-439f-b237-64a71a1ee3ac", - "metadata": {}, - "outputs": [], - "source": [ - "# -- datasite owners view logs from enclave on datasite\n", - "# -- step through execution policy at each step who did what" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.2" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} diff --git a/notebooks/scenarios/enclave/08-enclave-shutdown.ipynb b/notebooks/scenarios/enclave/08-enclave-shutdown.ipynb deleted file mode 100644 index 2f0e245e8fd..00000000000 --- a/notebooks/scenarios/enclave/08-enclave-shutdown.ipynb +++ /dev/null @@ -1,35 +0,0 @@ -{ - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "a3cfb45c-9dbd-485d-a71a-e024c9889715", - "metadata": {}, - "outputs": [], - "source": [ - "# -- primary terminates enclave" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.2" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} diff --git a/notebooks/scenarios/enclave/reset_nodes.ipynb b/notebooks/scenarios/enclave/reset_nodes.ipynb new file mode 100644 index 00000000000..13a93154fcc --- /dev/null +++ b/notebooks/scenarios/enclave/reset_nodes.ipynb @@ -0,0 +1,314 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "099cf5ab-f0c1-4283-bd3e-5ab1f60bd241", + "metadata": {}, + "outputs": [], + "source": [ + "# syft absolute\n", + "import syft as sy" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "a729b697-bb61-4e79-8d20-cd70019a1308", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Autoreload enabled\n", + "Starting model-owner server on 0.0.0.0:8081\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/madhavajay/dev/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8081 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [7091] using WatchFiles\n", + "INFO: Started server process [7114]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "WARNING: private key is based on server name: model-owner in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/ea6fe92e4be5471da3d1a423d39773d0/db/ea6fe92e4be5471da3d1a423d39773d0.sqlite\n", + "Action Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/ea6fe92e4be5471da3d1a423d39773d0/db/ea6fe92e4be5471da3d1a423d39773d0.sqlite\n", + "INFO: 127.0.0.1:58346 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: 
You have launched a development server at http://0.0.0.0:8081.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8081.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Stopping model-owner\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Shutting down\n", + "INFO: Waiting for application shutdown.\n", + "INFO: Application shutdown complete.\n", + "INFO: Finished server process [7114]\n", + "INFO: Stopping reloader process [7091]\n" + ] + } + ], + "source": [ + "# # use to reset db\n", + "model_owner_datasite = sy.orchestra.launch(\n", + " name=\"model-owner\", port=8081, dev_mode=True, reset=True\n", + ")\n", + "model_owner_datasite.land()" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "f78af200-8e65-416c-a831-9f1649bd7f16", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "The autoreload extension is already loaded. To reload it, use:\n", + " %reload_ext autoreload\n", + "Autoreload enabled\n", + "Starting azure-h100-enclave server on 0.0.0.0:8083\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/madhavajay/dev/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8083 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [7138] using WatchFiles\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Waiting for server to start" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Started server process [7151]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "WARNING: private key is based on server name: azure-h100-enclave in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/3ea33ab41d1349d29d94545fde3b6721/db/3ea33ab41d1349d29d94545fde3b6721.sqlite\n", + "Action Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/3ea33ab41d1349d29d94545fde3b6721/db/3ea33ab41d1349d29d94545fde3b6721.sqlite\n", + "INFO: 127.0.0.1:58354 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: 
You have launched a development server at http://0.0.0.0:8083.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8083.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Stopping azure-h100-enclave\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Shutting down\n", + "INFO: Waiting for application shutdown.\n", + "INFO: Application shutdown complete.\n", + "INFO: Finished server process [7151]\n", + "INFO: Stopping reloader process [7138]\n" + ] + } + ], + "source": [ + "# syft absolute\n", + "# use to reset\n", + "from syft.abstract_server import NodeType\n", + "\n", + "azure_h100_enclave = sy.orchestra.launch(\n", + " name=\"azure-h100-enclave\",\n", + " server_type=NodeType.ENCLAVE,\n", + " port=8083,\n", + " create_producer=True,\n", + " n_consumers=3,\n", + " dev_mode=True,\n", + " reset=True,\n", + ")\n", + "azure_h100_enclave.land()" + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "2349b180-5e67-4add-a13d-fe4b8ae5110c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "The autoreload extension is already loaded. To reload it, use:\n", + " %reload_ext autoreload\n", + "Autoreload enabled\n", + "Starting model-auditor server on 0.0.0.0:8082\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Will watch for changes in these directories: ['/Users/madhavajay/dev/PySyft/packages/syft/src/syft']\n", + "INFO: Uvicorn running on http://0.0.0.0:8082 (Press CTRL+C to quit)\n", + "INFO: Started reloader process [7172] using WatchFiles\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Waiting for server to start" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Started server process [7186]\n", + "INFO: Waiting for application startup.\n", + "INFO: Application startup complete.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "WARNING: private key is based on server name: model-auditor in dev_mode. Don't run this in production.\n", + "Document Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/d7ffd135e5914ab0b2138fc7d4f72ec0/db/d7ffd135e5914ab0b2138fc7d4f72ec0.sqlite\n", + "Action Store's SQLite DB path: /var/folders/6_/7xx0tpq16h9cn40mq4w5gjk80000gn/T/syft/d7ffd135e5914ab0b2138fc7d4f72ec0/db/d7ffd135e5914ab0b2138fc7d4f72ec0.sqlite\n", + "INFO: 127.0.0.1:58368 - \"GET /api/v2/metadata HTTP/1.1\" 200 OK\n", + " Done.\n" + ] + }, + { + "data": { + "text/html": [ + "
SyftInfo: 
You have launched a development server at http://0.0.0.0:8082.It is intended only for local use.

" + ], + "text/plain": [ + "SyftInfo: You have launched a development server at http://0.0.0.0:8082.It is intended only for local use." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Stopping model-auditor\n" + ] + }, + { + "name": "stderr", + "output_type": "stream", + "text": [ + "INFO: Shutting down\n", + "INFO: Waiting for application shutdown.\n", + "INFO: Application shutdown complete.\n", + "INFO: Finished server process [7186]\n", + "INFO: Stopping reloader process [7172]\n" + ] + } + ], + "source": [ + "# use to reset\n", + "model_auditor_datasite = sy.orchestra.launch(\n", + " name=\"model-auditor\", port=8082, dev_mode=True, reset=True\n", + ")\n", + "model_auditor_datasite.land()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "6c1c827e-8986-484f-be4c-c3a8820f9f13", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.12.2" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/packages/grid/backend/backend.dockerfile b/packages/grid/backend/backend.dockerfile index 256fdfd447b..a548eedff8e 100644 --- a/packages/grid/backend/backend.dockerfile +++ b/packages/grid/backend/backend.dockerfile @@ -1,6 +1,6 @@ ARG PYTHON_VERSION="3.12" ARG UV_VERSION="0.2.13-r0" -ARG TORCH_VERSION="2.2.2" +ARG TORCH_VERSION="2.3.1" # wolfi-os pkg definition links # https://github.com/wolfi-dev/os/blob/main/python-3.12.yaml diff --git a/packages/grid/devspace.yaml b/packages/grid/devspace.yaml index d2a2d975188..daef60f3857 100644 --- a/packages/grid/devspace.yaml +++ b/packages/grid/devspace.yaml @@ -224,8 +224,8 @@ profiles: value: - ./helm/examples/azure/azure.high.yaml - - name: enclave - description: "Deploy an enclave server" + - name: enclave-cpu + description: "Deploy an CPU enclave server" patches: # enable image build for enclave-attestation - op: add @@ -245,10 +245,54 @@ profiles: enclave-attestation: sync: - path: ./enclave/attestation/server:/app/server - # use gateway-specific chart values + # use enclave-specific chart values + - op: add + path: deployments.syft.helm.valuesFiles + value: ./helm/examples/dev/enclave-cpu.yaml + # Port Re-Mapping + - op: replace + path: dev.mongo.ports[0].port + value: 27019:27017 + - op: replace + path: dev.backend.ports[0].port + value: 5680:5678 + - op: replace + path: dev.backend.containers.backend-container.ssh.localPort + value: 3482 + - op: replace + path: dev.seaweedfs.ports + value: + - port: "9334:9333" # admin + - port: "8889:8888" # filer + - port: "8334:8333" # S3 + - port: "4002:4001" # mount api + + # TODO: Can we de-duplicate it? + - name: enclave-gpu + description: "Deploy an GPU enclave node" + patches: + # enable image build for enclave-attestation + - op: add + path: images + value: + enclave-attestation: + image: "${CONTAINER_REGISTRY}/${DOCKER_IMAGE_ENCLAVE_ATTESTATION}" + buildKit: + args: ["--platform", "linux/amd64"] + dockerfile: ./enclave/attestation/attestation.dockerfile + context: ./enclave/attestation + tags: + - dev-${DEVSPACE_TIMESTAMP} + - op: add + path: dev.backend.containers + value: + enclave-attestation: + sync: + - path: ./enclave/attestation/server:/app/server + # use enclave-specific chart values - op: add path: deployments.syft.helm.valuesFiles - value: ./helm/examples/dev/enclave.yaml + value: ./helm/examples/dev/enclave-gpu.yaml # Port Re-Mapping - op: replace path: dev.mongo.ports[0].port diff --git a/packages/grid/gpu-k3d.md b/packages/grid/gpu-k3d.md new file mode 100644 index 00000000000..ea216df20d3 --- /dev/null +++ b/packages/grid/gpu-k3d.md @@ -0,0 +1,25 @@ +## GPU Support - K3d + +This document details, on how to enable gpu support in PySyft. + +### 1. Step 0: Building k3s Image + +Perform this step only when creating new base k3s image or skip this step. + +This was tested with k3d guide version: 5.7.2 + +First , follow this link to create a GPU-based k3s image +https://k3d.io/v5.7.2/usage/advanced/cuda/ + +Build the image locally. +When building on MacOS , modify the build.sh script to have +`docker --platform linux/amd64,linux/arm64 ....` +and also enable containerd image store in docker desktop settings. + +Finally push the image to docker hub + +### Step 2: Launch Enclave with GPU + +```sh +DEVSPACE_PROFILE=enclave-gpu tox -e dev.k8s.launch.enclave +``` diff --git a/packages/grid/helm/examples/dev/enclave.yaml b/packages/grid/helm/examples/dev/enclave-cpu.yaml similarity index 70% rename from packages/grid/helm/examples/dev/enclave.yaml rename to packages/grid/helm/examples/dev/enclave-cpu.yaml index a42f6e6142f..f4c67a82f80 100644 --- a/packages/grid/helm/examples/dev/enclave.yaml +++ b/packages/grid/helm/examples/dev/enclave-cpu.yaml @@ -1,4 +1,4 @@ -# Values for deploying an enclave +# Values for deploying an cpu enclave # Patched on top of patch `base.yaml` server: diff --git a/packages/grid/helm/examples/dev/enclave-gpu.yaml b/packages/grid/helm/examples/dev/enclave-gpu.yaml new file mode 100644 index 00000000000..02e25483a36 --- /dev/null +++ b/packages/grid/helm/examples/dev/enclave-gpu.yaml @@ -0,0 +1,13 @@ +# Values for deploying in a gpu enclave +# Patched on top of patch `base.yaml` + +server: + type: enclave + runtimeClassName: nvidia + +attestation: + enabled: true + + resources: + limits: + nvidia.com/gpu: 1 diff --git a/packages/grid/helm/syft/templates/backend/backend-statefulset.yaml b/packages/grid/helm/syft/templates/backend/backend-statefulset.yaml index 226c8ab1dec..ac3fa721102 100644 --- a/packages/grid/helm/syft/templates/backend/backend-statefulset.yaml +++ b/packages/grid/helm/syft/templates/backend/backend-statefulset.yaml @@ -27,6 +27,9 @@ spec: annotations: {{- toYaml .Values.server.podAnnotations | nindent 8 }} {{- end }} spec: + {{- if .Values.server.runtimeClassName }} + runtimeClassName: {{ .Values.server.runtimeClassName }} + {{- end }} {{- if .Values.server.nodeSelector }} nodeSelector: {{- .Values.server.nodeSelector | toYaml | nindent 8 }} {{- end }} diff --git a/packages/grid/helm/syft/values.yaml b/packages/grid/helm/syft/values.yaml index 27e50438193..265fce73a4c 100644 --- a/packages/grid/helm/syft/values.yaml +++ b/packages/grid/helm/syft/values.yaml @@ -186,6 +186,9 @@ server: username: apikey password: password + # Runtime Class Name + runtimeClassName: null + # Extra environment vars env: null @@ -272,8 +275,8 @@ attestation: # Extra environment vars env: null - # Pod Resource Limits - resourcesPreset: nano + # Container Resource Limits + resourcesPreset: xlarge resources: null # ================================================================================= diff --git a/packages/grid/syft-client/syft.Dockerfile b/packages/grid/syft-client/syft.Dockerfile index abfed99480a..625278fd91a 100644 --- a/packages/grid/syft-client/syft.Dockerfile +++ b/packages/grid/syft-client/syft.Dockerfile @@ -1,10 +1,12 @@ ARG PYTHON_VERSION="3.12" +ARG TORCH_VERSION="2.3.1" # ==================== [BUILD STEP] Build Syft ==================== # FROM cgr.dev/chainguard/wolfi-base as syft_deps ARG PYTHON_VERSION +ARG TORCH_VERSION ENV PATH="/root/.local/bin:$PATH" @@ -14,10 +16,19 @@ RUN apk update && apk upgrade && \ # preemptive fix for wolfi-os breaking python entrypoint (test -f /usr/bin/python || ln -s /usr/bin/python3.12 /usr/bin/python) +# keep static deps separate to have each layer cached independently +# if amd64 then we need to append +cpu to the torch version +RUN --mount=type=cache,target=/root/.cache,sharing=locked \ + ARCH=$(arch | sed s/aarch64/arm64/ | sed s/x86_64/amd64/) && \ + if [[ "$ARCH" = "amd64" ]]; then TORCH_VERSION="$TORCH_VERSION+cpu"; fi && \ + pip install --user torch==$TORCH_VERSION --index-url https://download.pytorch.org/whl/cpu + COPY ./syft /tmp/syft RUN --mount=type=cache,target=/root/.cache,sharing=locked \ - pip install --user jupyterlab==4.2.2 /tmp/syft + # remove torch because we already have the cpu version pre-installed + sed --in-place /torch==/d ./tmp/syft/setup.cfg && \ + pip install --user jupyterlab==4.2.2 ./tmp/syft[data_science] # ==================== [Final] Setup Syft Client ==================== # diff --git a/packages/syft/setup.cfg b/packages/syft/setup.cfg index 9d579446775..009824ead28 100644 --- a/packages/syft/setup.cfg +++ b/packages/syft/setup.cfg @@ -67,6 +67,8 @@ syft = jinja2==3.1.4 tenacity==8.3.0 nh3==0.2.17 + pyjwt==2.8.0 + huggingface_hub==0.24.5 install_requires = %(syft)s @@ -89,6 +91,8 @@ data_science = recordlinkage==0.16 # backend.dockerfile installs torch separately, so update the version over there as well! torch==2.3.1 + accelerate==0.31.0 + inspect-ai==0.3.22 dev = %(test_plugins)s diff --git a/packages/syft/src/syft/__init__.py b/packages/syft/src/syft/__init__.py index 55975ac0069..eefc91b6239 100644 --- a/packages/syft/src/syft/__init__.py +++ b/packages/syft/src/syft/__init__.py @@ -58,15 +58,27 @@ from .service.dataset.dataset import Contributor from .service.dataset.dataset import CreateAsset as Asset from .service.dataset.dataset import CreateDataset as Dataset +from .service.model.model import CreateModel as Model +from .service.model.model import CreateModelAsset as ModelAsset +from .service.model.model import HFModelClass +from .service.model.model import SyftModelClass +from .service.model.model import syft_model +from .service.network.utils import check_route_reachability # noqa: F401 +from .service.network.utils import exchange_routes # noqa: F401 from .service.notification.notifications import NotificationStatus from .service.policy.policy import CreatePolicyRuleConstant as Constant from .service.policy.policy import CustomInputPolicy from .service.policy.policy import CustomOutputPolicy from .service.policy.policy import ExactMatch +from .service.policy.policy import InitCondition from .service.policy.policy import MixedInputPolicy +from .service.policy.policy import RunCondition +from .service.policy.policy import RunOnEnclave # noqa: F401 from .service.policy.policy import SingleExecutionExactOutput +from .service.policy.policy import StopCondition from .service.policy.policy import UserInputPolicy from .service.policy.policy import UserOutputPolicy +from .service.project.distributed_project import DistributedProject # noqa: F401 from .service.project.project import ProjectSubmit as Project from .service.request.request import SubmitRequest as Request from .service.response import SyftError @@ -75,6 +87,7 @@ from .service.user.roles import Roles as roles from .service.user.user_service import UserService from .stable_version import LATEST_STABLE_SYFT +from .types.file import SyftFolder from .types.twin_object import TwinObject from .types.uid import UID from .util import filterwarnings diff --git a/packages/syft/src/syft/assets/css/style.css b/packages/syft/src/syft/assets/css/style.css index 5fdee82e95d..b2e6919ee33 100644 --- a/packages/syft/src/syft/assets/css/style.css +++ b/packages/syft/src/syft/assets/css/style.css @@ -7,6 +7,8 @@ body.vscode-dark { --colors-black: #ffffff; --surface-color: #fff; --text-color: #ffffff; + --pre-code-bg: #212121; + --pre-code-border: #424242; } body { @@ -17,6 +19,8 @@ body { --colors-black: #17161d; --surface-color: #464158; --text-color: #2e2b3b; + --pre-code-bg: #f7f7f7; + --pre-code-border: #cfcfcf; } .header-1 { @@ -619,3 +623,13 @@ body { .syft-space { margin-top: 1em; } + +.jp-RenderedHTMLCommon pre { + background-color: var(--pre-code-bg); + border: 1px solid var(--pre-code-border); + padding: 16px; +} + +.jp-RenderedHTMLCommon code { + background-color: transparent; +} diff --git a/packages/syft/src/syft/assets/js/table.js b/packages/syft/src/syft/assets/js/table.js index 35fee482bd9..cf7212062c9 100644 --- a/packages/syft/src/syft/assets/js/table.js +++ b/packages/syft/src/syft/assets/js/table.js @@ -76,6 +76,10 @@ function buildTable( return; } + if (!rowHeader?.field) { + rowHeader = false; + } + const table = new Tabulator(`#${tableId}`, { data: data, columns: columns, diff --git a/packages/syft/src/syft/client/client.py b/packages/syft/src/syft/client/client.py index 243a3d5dc9a..8c462ca0939 100644 --- a/packages/syft/src/syft/client/client.py +++ b/packages/syft/src/syft/client/client.py @@ -710,6 +710,12 @@ def verify_key(self) -> SyftVerifyKey: raise ValueError("SigningKey not set on client") return self.credentials.verify_key + @property + def root_verify_key(self) -> SyftVerifyKey: + if self.metadata is None: + raise ValueError("Metadata not set on client") + return SyftVerifyKey.from_string(self.metadata.verify_key) + @classmethod def from_url(cls, url: str | ServerURL) -> Self: return cls(connection=HTTPConnection(url=ServerURL.from_url(url))) diff --git a/packages/syft/src/syft/client/datasite_client.py b/packages/syft/src/syft/client/datasite_client.py index aa7c2ce2894..05aba0f332f 100644 --- a/packages/syft/src/syft/client/datasite_client.py +++ b/packages/syft/src/syft/client/datasite_client.py @@ -25,6 +25,7 @@ from ..service.dataset.dataset import CreateAsset from ..service.dataset.dataset import CreateDataset from ..service.migration.object_migration_state import MigrationData +from ..service.model.model import CreateModel from ..service.response import SyftError from ..service.response import SyftSuccess from ..service.response import SyftWarning @@ -33,8 +34,10 @@ from ..service.user.roles import Roles from ..service.user.user import UserView from ..types.blob_storage import BlobFile +from ..types.file import SyftFolder from ..types.uid import UID from ..util.misc_objs import HTMLObject +from ..util.util import get_mb_serialized_size from ..util.util import get_mb_size from ..util.util import prompt_warning_message from .api import APIModule @@ -95,6 +98,104 @@ class DatasiteClient(SyftClient): def __repr__(self) -> str: return f"" + @property + def models(self) -> APIModule | None: + if self.api.has_service("model"): + return self.api.services.model + return None + + def upload_model(self, model: CreateModel) -> SyftSuccess | SyftError: + # relative + from ..service.model.model import ModelRef + from ..types.twin_object import TwinObject + + model_ref_action_ids = [] + + # Step 1. Upload Model Code to Action Store + model.code.syft_server_location = self.id + model.code.syft_client_verify_key = self.verify_key + model.code._save_to_blob_storage() + model_code_res = self.api.services.action.set(model.code) + if isinstance(model_code_res, SyftError): + return model_code_res + model.code_action_id = model_code_res.id + model_ref_action_ids.append(model_code_res.id) + + # Step 2. Upload Model Assets to Action Store + + model_size: float = 0.0 + with tqdm( + total=len(model.asset_list), colour="green", desc="Uploading assets" + ) as pbar: + for asset in model.asset_list: + try: + contains_empty: bool = asset.contains_empty() + twin = TwinObject( + private_obj=ActionObject.from_obj(asset.data), + mock_obj=ActionObject.from_obj(asset.mock), + syft_server_location=self.id, + syft_client_verify_key=self.verify_key, + ) + res = twin._save_to_blob_storage(allow_empty=contains_empty) + if isinstance(res, SyftError): + return res + except Exception as e: + tqdm.write(f"Failed to create twin for {asset.name}. {e}") + return SyftError(message=f"Failed to create twin. {e}") + + if isinstance(res, SyftWarning): + logger.debug(res.message) + # Clear Cache before saving + twin.private_obj._clear_cache() + twin.mock_obj._clear_cache() + response = self.api.services.action.set( + twin, ignore_detached_objs=contains_empty + ) + if isinstance(response, SyftError): + tqdm.write(f"Failed to upload asset: {asset.name}") + return response + + asset.action_id = twin.id + asset.server_uid = self.id + model_size += ( + asset.data.size_mb + if isinstance(asset.data, SyftFolder) + else get_mb_serialized_size(asset.data) + ) + model_ref_action_ids.append(twin.id) + + # Clear the Data and Mock , as they are uploaded as twin object + asset.data = None + asset.mock = None + + # Update the progress bar and set the dynamic description + pbar.set_description(f"Uploading: {asset.name} asset") + pbar.update(1) + + # Step 3. Upload Model Ref to Action Store + # Model Ref is a reference to the model code and assets + # Stored as a list of ActionObject ids + # [model_code_id, asset1_id, asset2_id, ...] + # TODO: Move ModelRef to be created at the server side + model_ref = ModelRef( + id=model.id, + syft_action_data_cache=model_ref_action_ids, + syft_server_location=self.id, + syft_client_verify_key=self.verify_key, + ) + model_ref._save_to_blob_storage() + model_ref_res = self.api.services.action.set(model_ref) + if isinstance(model_ref_res, SyftError): + return model_ref_res + + model.mb_size = model_size + valid = model.check() + if isinstance(valid, SyftError): + return valid + + # Step 4. Upload Model to Model Stash + return self.api.services.model.add(model=model) + def upload_dataset(self, dataset: CreateDataset) -> SyftSuccess | SyftError: # relative from ..types.twin_object import TwinObject @@ -129,7 +230,7 @@ def upload_dataset(self, dataset: CreateDataset) -> SyftSuccess | SyftError: prompt_warning_message(message=message, confirm=True) with tqdm( - total=len(dataset.asset_list), colour="green", desc="Uploading" + total=len(dataset.asset_list), colour="green", desc="Uploading assets" ) as pbar: for asset in dataset.asset_list: try: @@ -161,7 +262,7 @@ def upload_dataset(self, dataset: CreateDataset) -> SyftSuccess | SyftError: dataset_size += get_mb_size(asset.data) # Update the progress bar and set the dynamic description - pbar.set_description(f"Uploading: {asset.name}") + pbar.set_description(f"Uploading: {asset.name} asset") pbar.update(1) dataset.mb_size = dataset_size @@ -349,6 +450,14 @@ def data_subject_registry(self) -> APIModule | None: def code(self) -> APIModule | None: return self._get_service_by_name_if_exists("code") + @property + def network(self) -> APIModule | None: + return self._get_service_by_name_if_exists("network") + + @property + def enclaves(self) -> APIModule | None: + return self._get_service_by_name_if_exists("enclave") + @property def worker(self) -> APIModule | None: return self._get_service_by_name_if_exists("worker") diff --git a/packages/syft/src/syft/client/enclave_client.py b/packages/syft/src/syft/client/enclave_client.py index dc5da06ed3c..71da9bc1c68 100644 --- a/packages/syft/src/syft/client/enclave_client.py +++ b/packages/syft/src/syft/client/enclave_client.py @@ -38,21 +38,6 @@ class EnclaveMetadata(SyftObject): class EnclaveClient(SyftClient): # TODO: add widget repr for enclave client - __api_patched = False - - @property - def code(self) -> APIModule | None: - if self.api.has_service("code"): - res = self.api.services.code - # the order is important here - # its also important that patching only happens once - if not self.__api_patched: - self._request_code_execution = res.request_code_execution - self.__api_patched = True - res.request_code_execution = self.request_code_execution - return res - return None - @property def requests(self) -> APIModule | None: if self.api.has_service("request"): diff --git a/packages/syft/src/syft/orchestra.py b/packages/syft/src/syft/orchestra.py index ebe74b85d31..d6556ce5b30 100644 --- a/packages/syft/src/syft/orchestra.py +++ b/packages/syft/src/syft/orchestra.py @@ -186,6 +186,9 @@ def deploy_to_python( background_tasks: bool = False, debug: bool = False, migrate: bool = False, + profile: bool = False, + profile_interval: float = 0.001, + profile_dir: str | None = None, ) -> ServerHandle: worker_classes = { ServerType.DATASITE: Datasite, @@ -215,6 +218,9 @@ def deploy_to_python( "background_tasks": background_tasks, "debug": debug, "migrate": migrate, + "profile": profile, + "profile_interval": profile_interval, + "profile_dir": profile_dir, } if port: @@ -325,6 +331,10 @@ def launch( background_tasks: bool = False, debug: bool = False, migrate: bool = False, + # Profiling Related Input for in-memory fastapi server + profile: bool = False, + profile_interval: float = 0.001, + profile_dir: str | None = None, ) -> ServerHandle: if dev_mode is True: thread_workers = True @@ -363,6 +373,9 @@ def launch( background_tasks=background_tasks, debug=debug, migrate=migrate, + profile=profile, + profile_interval=profile_interval, + profile_dir=profile_dir, ) display( SyftInfo( diff --git a/packages/syft/src/syft/protocol/protocol_version.json b/packages/syft/src/syft/protocol/protocol_version.json index a7bb8d85399..9c0baa61eee 100644 --- a/packages/syft/src/syft/protocol/protocol_version.json +++ b/packages/syft/src/syft/protocol/protocol_version.json @@ -1,5 +1,282 @@ { "1": { "release_name": "0.8.7.json" + }, + "dev": { + "object_versions": { + "EnclaveMetadata": { + "1": { + "version": 1, + "hash": "8d2dfafa01ec909c080a790cf15a8fc78e00382d3bfe6207098ceb25a60b9c53", + "action": "add" + } + }, + "EnclaveInstance": { + "1": { + "version": 1, + "hash": "f923fd76e25b851901d44bc9f75a311ecacce00e789777de9e94833e61fe98e8", + "action": "add" + } + }, + "RunOnEnclave": { + "1": { + "version": 1, + "hash": "cbb26a20dd62eef9e39544b4bae9c608115a188b9d6d695fd4f9a1157234dd9b", + "action": "add" + } + }, + "UserCode": { + "2": { + "version": 2, + "hash": "b3d665db8e93e3f1fd2288b95fb12ebb46e2a2c4c13a67e1a65a3dd60e44561b", + "action": "add" + } + }, + "SubmitUserCode": { + "2": { + "version": 2, + "hash": "5ae1ff84ce31b39a6751c94373801104c6bb851d8b4577202b6a1676f53fbc38", + "action": "add" + } + }, + "ModelPageView": { + "1": { + "version": 1, + "hash": "806eaa772a78b833137cb1abc9d80c5e064bbcd21314a1c202ee756837a8121d", + "action": "add" + } + }, + "ModelAsset": { + "1": { + "version": 1, + "hash": "028c1eb30b2321184c43de2dd6d47b39c8f933b89174f7f7e70d8e667b19fcd0", + "action": "add" + } + }, + "SubmitModelCode": { + "1": { + "version": 1, + "hash": "eca26af6cbc0a6557ac6e15c5b81fe78053eace9de5adef8ffcacce3ad8a3133", + "action": "add" + } + }, + "CreateModelAsset": { + "1": { + "version": 1, + "hash": "180154b131e098338f7d85a40358eae077d899969f77b6cd177b67834a1d5464", + "action": "add" + } + }, + "Model": { + "1": { + "version": 1, + "hash": "ea1146c9e3e750804f5769df9afe57f2f32d1f2ec07106211361959451b19c8d", + "action": "add" + } + }, + "CreateModel": { + "1": { + "version": 1, + "hash": "6d45537fc735d3e02dabaca6a24a2bc29b76f9f75218cb9f9dc7ef25044058ec", + "action": "add" + } + }, + "ModelRef": { + "1": { + "version": 1, + "hash": "d7690a53229e4335cbfa0ad2669a8c24f0da7aae871c1aabad0e461ee7621ffd", + "action": "add" + } + }, + "AssociationRequestChange": { + "2": { + "version": 2, + "hash": "5f73ea150e3b08c28b2d9e7e7d8b7a00eb73f69f80e9c7760589d44729300d4b", + "action": "add" + } + }, + "ProjectRequestResponse": { + "2": { + "version": 2, + "hash": "e26a7080b198c7f0d936c6a7fcfe776c706d381698812509984def628c3eb5fc", + "action": "add" + } + }, + "ProjectRequest": { + "2": { + "version": 2, + "hash": "477118d553747d2e201bcbe055798983c2e410c7dec589ddc635525a28e2f37d", + "action": "add" + } + }, + "ProjectCode": { + "1": { + "version": 1, + "hash": "7254fc3c1574c8148ccb258e995c2826c6f35e210406e2d4c55f4e17832c05fe", + "action": "add" + } + }, + "SyftFile": { + "1": { + "version": 1, + "hash": "016119165ba4868f03364e79192e7e8face085ff1998a1920423fd5822ca5443", + "action": "add" + } + }, + "SyftFolder": { + "1": { + "version": 1, + "hash": "26bb701dcf2012589b476ba83a67d4405baf12da9628ac490bcd23e343e60645", + "action": "add" + } + }, + "Asset": { + "2": { + "version": 2, + "hash": "ab3a6ec2957b4f2f9e37589fe7dd753ef6c045853f459ffd0d74ddcd1cc8e442", + "action": "add" + } + }, + "RuntimePolicy": { + "1": { + "version": 1, + "hash": "ee7e1fdf0c525cc051888ca4516dc2e102f02044c92dfea91555b70776da6a86", + "action": "add" + } + }, + "EmptyRuntimePolicy": { + "1": { + "version": 1, + "hash": "b8555d4cbb03e4d627aed5eb2096ec4b28cfef981e5524873f1d40bd37fa55e3", + "action": "add" + } + }, + "ActionObject": { + "2": { + "version": 2, + "hash": "f8c925b930541d761e600a6a0957e8a202d371fdb81c969b8586a07678761ddc", + "action": "add" + } + }, + "AnyActionObject": { + "2": { + "version": 2, + "hash": "6c3f0dc3aece484a992155d41af5bd09bab6075ec6424d297729ece7129e4ae7", + "action": "add" + } + }, + "BlobFileOBject": { + "2": { + "version": 2, + "hash": "90c111cd8ada881cd9b01e6497a07a34d7ff445a7ffd2b593418c84dc5b161d7", + "action": "add" + } + }, + "NumpyArrayObject": { + "2": { + "version": 2, + "hash": "33f68f5396e5f4569be64af4eaf0610e53b0a55141aa45a0c0a3543add383d29", + "action": "add" + } + }, + "NumpyScalarObject": { + "2": { + "version": 2, + "hash": "304c615841b63a99bf8e8567ed8acbce1cb61b9d3e6299bc4207ae92c53ebc53", + "action": "add" + } + }, + "NumpyBoolObject": { + "2": { + "version": 2, + "hash": "98dce617f4dd9ce1c9c30d930d557c574b9f873968461f70de74989be63f9d60", + "action": "add" + } + }, + "PandasDataframeObject": { + "2": { + "version": 2, + "hash": "3dbd6c97379338902b8da4519a250e9f7d6b2ae755bdb1b68b0aa6a2f3106d6c", + "action": "add" + } + }, + "PandasSeriesObject": { + "2": { + "version": 2, + "hash": "09d6867be6a50aef4aa7ad67a10ed52c23d863fe49d2294dff930e9a76f3e6ca", + "action": "add" + } + }, + "SyftObjectRetrieval": { + "1": { + "version": 1, + "hash": "b2b62447445adc4cd0b77ab59d6fa56624dd316fb50281e570daad07556b6db2", + "action": "remove" + } + }, + "VerifiableOutput": { + "1": { + "version": 1, + "hash": "0f4cd9f7541cfdfadc16b1192b4371001f948fb59a17f996f062039b885d52f1", + "action": "add" + } + }, + "InitCondition": { + "1": { + "version": 1, + "hash": "4188cf57775565da05045188ca0eaf22ef197fc2eff6acf06880360fe80dc2bb", + "action": "add" + } + }, + "RunCondition": { + "1": { + "version": 1, + "hash": "8db841b73a0acbc7a720456a8077731ad3ad49118805473b8aa187e8e6904f45", + "action": "add" + } + }, + "StopCondition": { + "1": { + "version": 1, + "hash": "1e76d224e9cd6fc756b04cc3d182d35f7fbd5aab367ea9c868c87f8f7c082fbd", + "action": "add" + } + }, + "ProjectAssetTransfer": { + "1": { + "version": 1, + "hash": "aba31650f28cdfeee16e782e12be2b622dcd503ea3eee457552a618bd2b7994d", + "action": "add" + } + }, + "ProjectAttestationReport": { + "1": { + "version": 1, + "hash": "b7a3fd8fdc822f71f469fa8fa196d68bb00fc7d7a3081ce2efa0d0460d158331", + "action": "add" + } + }, + "ProjectExecutionStart": { + "1": { + "version": 1, + "hash": "fe7c3dc9a55eb8502f1974a2676850ab292127f5c9023977553ac17011102a79", + "action": "add" + } + }, + "ProjectEnclaveOutput": { + "1": { + "version": 1, + "hash": "dba43d43031425fbb3f5534549bd9c4d162ec8fb0470a062a4ff6a3e67cf3114", + "action": "add" + } + }, + "RuntimePolicyCondition": { + "1": { + "version": 1, + "hash": "9a9821eed90768e26fadcb68f233507e1dbaff20e0802fb2317c2fa91f66feab", + "action": "add" + } + } + } } } diff --git a/packages/syft/src/syft/server/routes.py b/packages/syft/src/syft/server/routes.py index e4d6906ae7f..c4f5dc2a4f1 100644 --- a/packages/syft/src/syft/server/routes.py +++ b/packages/syft/src/syft/server/routes.py @@ -2,7 +2,10 @@ import base64 import binascii from collections.abc import AsyncGenerator +from collections.abc import Callable +from datetime import datetime import logging +from pathlib import Path from typing import Annotated # third party @@ -34,12 +37,13 @@ from ..util.telemetry import TRACE_MODE from .credentials import SyftVerifyKey from .credentials import UserLoginCredentials +from .server_settings import ServerSettings from .worker import Worker logger = logging.getLogger(__name__) -def make_routes(worker: Worker) -> APIRouter: +def make_routes(worker: Worker, settings: ServerSettings | None = None) -> APIRouter: if TRACE_MODE: # third party try: @@ -49,6 +53,34 @@ def make_routes(worker: Worker) -> APIRouter: except Exception as e: logger.error("Failed to import opentelemetry", exc_info=e) + def _handle_profile( + request: Request, handler_func: Callable, *args: list, **kwargs: dict + ) -> Response: + if not settings: + raise Exception("Server Settings are required to enable profiling") + # third party + from pyinstrument import Profiler # Lazy Load + + profiles_dir = Path(settings.profile_dir or Path.cwd()) / "profiles" + profiles_dir.mkdir(parents=True, exist_ok=True) + + with Profiler( + interval=settings.profile_interval, async_mode="enabled" + ) as profiler: + response = handler_func(*args, **kwargs) + + timestamp = datetime.now().strftime("%d-%m-%Y-%H:%M:%S") + url_path = request.url.path.replace("/api/v2", "").replace("/", "-") + profile_output_path = ( + profiles_dir / f"{settings.name}-{timestamp}{url_path}.html" + ) + profiler.write_html(profile_output_path) + + logger.info( + f"Request to {request.url.path} took {profiler.last_session.duration:.2f} seconds" + ) + return response + router = APIRouter() async def get_body(request: Request) -> bytes: @@ -165,6 +197,13 @@ def syft_new_api( kind=trace.SpanKind.SERVER, ): return handle_syft_new_api(user_verify_key, communication_protocol) + elif settings and settings.profile: + return _handle_profile( + request, + handle_syft_new_api, + user_verify_key, + communication_protocol, + ) else: return handle_syft_new_api(user_verify_key, communication_protocol) @@ -188,6 +227,8 @@ def syft_new_api_call( kind=trace.SpanKind.SERVER, ): return handle_new_api_call(data) + elif settings and settings.profile: + return _handle_profile(request, handle_new_api_call, data) else: return handle_new_api_call(data) @@ -255,6 +296,8 @@ def login( kind=trace.SpanKind.SERVER, ): return handle_login(email, password, worker) + elif settings and settings.profile: + return _handle_profile(request, handle_login, email, password, worker) else: return handle_login(email, password, worker) @@ -269,6 +312,8 @@ def register( kind=trace.SpanKind.SERVER, ): return handle_register(data, worker) + elif settings and settings.profile: + return _handle_profile(request, handle_register, data, worker) else: return handle_register(data, worker) diff --git a/packages/syft/src/syft/server/server.py b/packages/syft/src/syft/server/server.py index e386dacb7a6..cdae4441838 100644 --- a/packages/syft/src/syft/server/server.py +++ b/packages/syft/src/syft/server/server.py @@ -456,6 +456,7 @@ def get_default_store(self, use_sqlite: bool, store_type: str) -> StoreConfig: file_name: str = f"{self.id}.sqlite" if self.dev_mode: logger.debug(f"{store_type}'s SQLite DB path: {path/file_name}") + print(f"{store_type}'s SQLite DB path: {path/file_name}") return SQLiteStoreConfig( client_config=SQLiteStoreClientConfig( filename=file_name, diff --git a/packages/syft/src/syft/server/server_settings.py b/packages/syft/src/syft/server/server_settings.py new file mode 100644 index 00000000000..9416adf904c --- /dev/null +++ b/packages/syft/src/syft/server/server_settings.py @@ -0,0 +1,30 @@ +# third party +from pydantic_settings import BaseSettings +from pydantic_settings import SettingsConfigDict + +# relative +from ..abstract_server import ServerSideType +from ..abstract_server import ServerType + + +class ServerSettings(BaseSettings): + name: str + server_type: ServerType = ServerType.DATASITE + server_side_type: ServerSideType = ServerSideType.HIGH_SIDE + processes: int = 1 + reset: bool = False + dev_mode: bool = False + enable_warnings: bool = False + in_memory_workers: bool = True + queue_port: int | None = None + create_producer: bool = False + n_consumers: int = 0 + association_request_auto_approval: bool = False + background_tasks: bool = False + + # Profiling inputs + profile: bool = False + profile_interval: float = 0.001 + profile_dir: str | None = None + + model_config = SettingsConfigDict(env_prefix="SYFT_", env_parse_none_str="None") diff --git a/packages/syft/src/syft/server/service_registry.py b/packages/syft/src/syft/server/service_registry.py index d7c3555f10c..3914353df2b 100644 --- a/packages/syft/src/syft/server/service_registry.py +++ b/packages/syft/src/syft/server/service_registry.py @@ -19,11 +19,13 @@ from ..service.data_subject.data_subject_member_service import DataSubjectMemberService from ..service.data_subject.data_subject_service import DataSubjectService from ..service.dataset.dataset_service import DatasetService +from ..service.enclave.datasite_enclave_service import DatasiteEnclaveService from ..service.enclave.enclave_service import EnclaveService from ..service.job.job_service import JobService from ..service.log.log_service import LogService from ..service.metadata.metadata_service import MetadataService from ..service.migration.migration_service import MigrationService +from ..service.model.model_service import ModelService from ..service.network.network_service import NetworkService from ..service.notification.notification_service import NotificationService from ..service.notifier.notifier_service import NotifierService @@ -51,7 +53,6 @@ class ServiceRegistry: action: ActionService user: UserService - attestation: AttestationService worker: WorkerService settings: SettingsService dataset: DatasetService @@ -68,7 +69,6 @@ class ServiceRegistry: notification: NotificationService data_subject_member: DataSubjectMemberService project: ProjectService - enclave: EnclaveService code_history: CodeHistoryService metadata: MetadataService blob_storage: BlobStorageService @@ -79,6 +79,12 @@ class ServiceRegistry: sync: SyncService output: OutputService user_code_status: UserCodeStatusService + model: ModelService + + # Encalve services + enclave: EnclaveService + datasite_enclave: DatasiteEnclaveService + attestation: AttestationService services: list[AbstractService] = field(default_factory=list, init=False) service_path_map: dict[str, AbstractService] = field( diff --git a/packages/syft/src/syft/server/uvicorn.py b/packages/syft/src/syft/server/uvicorn.py index 953d19a4c2e..702ce8cc1c2 100644 --- a/packages/syft/src/syft/server/uvicorn.py +++ b/packages/syft/src/syft/server/uvicorn.py @@ -1,5 +1,6 @@ # stdlib from collections.abc import Callable +from datetime import datetime import logging import multiprocessing import multiprocessing.synchronize @@ -15,8 +16,8 @@ # third party from fastapi import APIRouter from fastapi import FastAPI -from pydantic_settings import BaseSettings -from pydantic_settings import SettingsConfigDict +from fastapi import Request +from fastapi import Response import requests from starlette.middleware.cors import CORSMiddleware import uvicorn @@ -32,6 +33,7 @@ from .gateway import Gateway from .routes import make_routes from .server import ServerType +from .server_settings import ServerSettings from .utils import get_named_server_uid from .utils import remove_temp_dir_for_server @@ -43,26 +45,8 @@ WAIT_TIME_SECONDS = 20 -class AppSettings(BaseSettings): - name: str - server_type: ServerType = ServerType.DATASITE - server_side_type: ServerSideType = ServerSideType.HIGH_SIDE - processes: int = 1 - reset: bool = False - dev_mode: bool = False - enable_warnings: bool = False - in_memory_workers: bool = True - queue_port: int | None = None - create_producer: bool = False - n_consumers: int = 0 - association_request_auto_approval: bool = False - background_tasks: bool = False - - model_config = SettingsConfigDict(env_prefix="SYFT_", env_parse_none_str="None") - - def app_factory() -> FastAPI: - settings = AppSettings() + settings = ServerSettings() worker_classes = { ServerType.DATASITE: Datasite, @@ -75,21 +59,49 @@ def app_factory() -> FastAPI: ) worker_class = worker_classes[settings.server_type] - kwargs = settings.model_dump() + worker_kwargs = settings.model_dump() + # Remove Profiling inputs + worker_kwargs.pop("profile") + worker_kwargs.pop("profile_interval") + worker_kwargs.pop("profile_dir") if settings.dev_mode: print( f"WARN: private key is based on server name: {settings.name} in dev_mode. " "Don't run this in production." ) - worker = worker_class.named(**kwargs) + worker = worker_class.named(**worker_kwargs) else: - worker = worker_class(**kwargs) + worker = worker_class(**worker_kwargs) app = FastAPI(title=settings.name) - router = make_routes(worker=worker) + router = make_routes(worker=worker, settings=settings) api_router = APIRouter() api_router.include_router(router) app.include_router(api_router, prefix="/api/v2") + + # Register middlewares + _register_middlewares(app, settings) + + return app + + +def _register_middlewares(app: FastAPI, settings: ServerSettings) -> None: + _register_cors_middleware(app) + + # As currently sync routes are not supported in pyinstrument + # we are not registering the profiler middleware for sync routes + # as currently most of our routes are sync routes in syft (routes.py) + # ex: syft_new_api, syft_new_api_call, login, register + # we should either convert these routes to async or + # wait until pyinstrument supports sync routes + # The reason we cannot our sync routes to async is because + # we have blocking IO operations, like the requests library, like if one route calls to + # itself, it will block the event loop and the server will hang + # if settings.profile: + # _register_profiler(app, settings) + + +def _register_cors_middleware(app: FastAPI) -> None: app.add_middleware( CORSMiddleware, allow_origins=["*"], @@ -97,7 +109,55 @@ def app_factory() -> FastAPI: allow_methods=["*"], allow_headers=["*"], ) - return app + + +def _register_profiler(app: FastAPI, settings: ServerSettings) -> None: + # third party + from pyinstrument import Profiler + + profiles_dir = ( + Path.cwd() / "profiles" + if settings.profile_dir is None + else Path(settings.profile_dir) / "profiles" + ) + + @app.middleware("http") + async def profile_request( + request: Request, call_next: Callable[[Request], Response] + ) -> Response: + with Profiler( + interval=settings.profile_interval, async_mode="enabled" + ) as profiler: + response = await call_next(request) + + # Profile File Name - Datasite Name - Timestamp - URL Path + timestamp = datetime.now().strftime("%d-%m-%Y-%H:%M:%S") + profiles_dir.mkdir(parents=True, exist_ok=True) + url_path = request.url.path.replace("/api/v2", "").replace("/", "-") + profile_output_path = ( + profiles_dir / f"{settings.name}-{timestamp}{url_path}.html" + ) + + # Write the profile to a HTML file + profiler.write_html(profile_output_path) + + print( + f"Request to {request.url.path} took {profiler.last_session.duration:.2f} seconds" + ) + + return response + + +def _load_pyinstrument_jupyter_extension() -> None: + try: + # third party + from IPython import get_ipython + + ipython = get_ipython() # noqa: F821 + ipython.run_line_magic("load_ext", "pyinstrument") + print("Pyinstrument Jupyter extension loaded") + except Exception as e: + print(f"Error loading pyinstrument jupyter extension: {e}") def attach_debugger() -> None: @@ -152,7 +212,7 @@ def run_uvicorn( attach_debugger() # Set up all kwargs as environment variables so that they can be accessed in the app_factory function. - env_prefix = AppSettings.model_config.get("env_prefix", "") + env_prefix = ServerSettings.model_config.get("env_prefix", "") for key, value in kwargs.items(): key_with_prefix = f"{env_prefix}{key.upper()}" os.environ[key_with_prefix] = str(value) @@ -198,6 +258,10 @@ def serve_server( association_request_auto_approval: bool = False, background_tasks: bool = False, debug: bool = False, + # Profiling inputs + profile: bool = False, + profile_interval: float = 0.001, + profile_dir: str | None = None, ) -> tuple[Callable, Callable]: starting_uvicorn_event = multiprocessing.Event() @@ -205,6 +269,12 @@ def serve_server( if dev_mode: enable_autoreload() + # Load the Pyinstrument Jupyter extension if profile is enabled. + if profile: + _load_pyinstrument_jupyter_extension() + if profile_dir is None: + profile_dir = str(Path.cwd()) + server_process = multiprocessing.Process( target=run_uvicorn, kwargs={ @@ -225,6 +295,9 @@ def serve_server( "background_tasks": background_tasks, "debug": debug, "starting_uvicorn_event": starting_uvicorn_event, + "profile": profile, + "profile_interval": profile_interval, + "profile_dir": profile_dir, }, ) diff --git a/packages/syft/src/syft/service/action/action_object.py b/packages/syft/src/syft/service/action/action_object.py index bbad29396b9..a7154f54a77 100644 --- a/packages/syft/src/syft/service/action/action_object.py +++ b/packages/syft/src/syft/service/action/action_object.py @@ -5,6 +5,7 @@ from collections.abc import Callable from collections.abc import Iterable from enum import Enum +import hashlib import inspect from io import BytesIO import logging @@ -44,9 +45,11 @@ from ...types.base import SyftBaseModel from ...types.datetime import DateTime from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from ...types.syft_object import SyftBaseObject from ...types.syft_object import SyftObject from ...types.syncable_object import SyncableSyftObject +from ...types.transforms import TransformContext from ...types.uid import LineageID from ...types.uid import UID from ...util.util import prompt_warning_message @@ -662,6 +665,8 @@ def debox_args_and_kwargs(args: Any, kwargs: Any) -> tuple[Any, Any]: "__table_coll_widths__", "_clear_cache", "_set_reprs", + "hash", + "syft_action_data_hash", ] @@ -674,7 +679,7 @@ def truncate_str(string: str, length: int = 100) -> str: @serializable(without=["syft_pre_hooks__", "syft_post_hooks__"]) -class ActionObject(SyncableSyftObject): +class ActionObjectV1(SyncableSyftObject): """Action object for remote execution.""" __canonical_name__ = "ActionObject" @@ -712,6 +717,47 @@ class ActionObject(SyncableSyftObject): syft_action_saved_to_blob_store: bool = True # syft_dont_wrap_attrs = ["shape"] + +@serializable(without=["syft_pre_hooks__", "syft_post_hooks__"]) +class ActionObject(SyncableSyftObject): + """Action object for remote execution.""" + + __canonical_name__ = "ActionObject" + __version__ = SYFT_OBJECT_VERSION_2 + __private_sync_attr_mocks__: ClassVar[dict[str, Any]] = { + "syft_action_data_cache": None, + "syft_blob_storage_entry_id": None, + } + + __attr_searchable__: list[str] = [] # type: ignore[misc] + syft_action_data_cache: Any | None = None + syft_blob_storage_entry_id: UID | None = None + syft_pointer_type: ClassVar[type[ActionObjectPointer]] + syft_action_data_hash: str | None = None + + # Help with calculating history hash for code verification + syft_parent_hashes: int | list[int] | None = None + syft_parent_op: str | None = None + syft_parent_args: Any | None = None + syft_parent_kwargs: Any | None = None + syft_history_hash: int | None = None + syft_internal_type: ClassVar[type[Any]] + syft_server_uid: UID | None = None + syft_pre_hooks__: dict[str, list] = {} + syft_post_hooks__: dict[str, list] = {} + syft_twin_type: TwinMode = TwinMode.NONE + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + syft_action_data_type: type | None = None + syft_action_data_repr_: str | None = None + syft_action_data_str_: str | None = None + syft_has_bool_attr: bool | None = None + syft_resolve_data: bool | None = None + syft_created_at: DateTime | None = None + syft_resolved: bool = True + syft_action_data_server_id: UID | None = None + syft_action_saved_to_blob_store: bool = True + # syft_dont_wrap_attrs = ["shape"] + def syft_get_diffs(self, ext_obj: Any) -> list[AttrDiff]: # relative from ...service.sync.diff_state import AttrDiff @@ -773,10 +819,13 @@ def reload_cache(self) -> SyftError | None: return blob_retrieval_object # relative from ...store.blob_storage import BlobRetrieval + from ...store.blob_storage import SyftObjectRetrieval if isinstance(blob_retrieval_object, SyftError): return blob_retrieval_object - elif isinstance(blob_retrieval_object, BlobRetrieval): + elif isinstance( + blob_retrieval_object, BlobRetrieval | SyftObjectRetrieval + ): # TODO: This change is temporary to for gateway to be compatible with the new blob storage self.syft_action_data_cache = blob_retrieval_object.read() self.syft_action_data_type = type(self.syft_action_data) @@ -795,7 +844,9 @@ def reload_cache(self) -> SyftError | None: return None - def _save_to_blob_storage_(self, data: Any) -> SyftError | SyftWarning | None: + def _save_to_blob_storage_( + self, data: Any, client: SyftClient | None + ) -> SyftError | SyftWarning | None: # relative from ...types.blob_storage import BlobFile from ...types.blob_storage import CreateBlobStorageEntry @@ -803,16 +854,25 @@ def _save_to_blob_storage_(self, data: Any) -> SyftError | SyftWarning | None: if not isinstance(data, ActionDataEmpty): if isinstance(data, BlobFile): if not data.uploaded: - api = APIRegistry.api_for( - self.syft_server_location, self.syft_client_verify_key + api = ( + APIRegistry.api_for( + self.syft_server_location, self.syft_client_verify_key + ) + if client is None + else client.api ) data._upload_to_blobstorage_from_api(api) else: - get_metadata = from_api_or_context( - func_or_path="metadata.get_metadata", - syft_server_location=self.syft_server_location, - syft_client_verify_key=self.syft_client_verify_key, + get_metadata = ( + from_api_or_context( + func_or_path="metadata.get_metadata", + syft_server_location=self.syft_server_location, + syft_client_verify_key=self.syft_client_verify_key, + ) + if client is None + else client.api.services.metadata.get_metadata ) + if get_metadata is not None and not can_upload_to_blob_storage( data, get_metadata() ): @@ -824,16 +884,19 @@ def _save_to_blob_storage_(self, data: Any) -> SyftError | SyftWarning | None: serialized = serialize(data, to_bytes=True) size = sys.getsizeof(serialized) storage_entry = CreateBlobStorageEntry.from_obj(data, file_size=size) - if not TraceResultRegistry.current_thread_is_tracing(): self.syft_action_data_cache = self.as_empty_data() if self.syft_blob_storage_entry_id is not None: # TODO: check if it already exists storage_entry.id = self.syft_blob_storage_entry_id - allocate_method = from_api_or_context( - func_or_path="blob_storage.allocate", - syft_server_location=self.syft_server_location, - syft_client_verify_key=self.syft_client_verify_key, + allocate_method = ( + from_api_or_context( + func_or_path="blob_storage.allocate", + syft_server_location=self.syft_server_location, + syft_client_verify_key=self.syft_client_verify_key, + ) + if client is None + else client.api.services.blob_storage.allocate ) if allocate_method is not None: blob_deposit_object = allocate_method(storage_entry) @@ -863,7 +926,7 @@ def _save_to_blob_storage_(self, data: Any) -> SyftError | SyftWarning | None: return None def _save_to_blob_storage( - self, allow_empty: bool = False + self, allow_empty: bool = False, client: SyftClient | None = None ) -> SyftError | SyftSuccess | SyftWarning: data = self.syft_action_data if isinstance(data, SyftError): @@ -875,7 +938,7 @@ def _save_to_blob_storage( ) try: - result = self._save_to_blob_storage_(data) + result = self._save_to_blob_storage_(data, client=client) if isinstance(result, SyftError | SyftWarning): return result if not TraceResultRegistry.current_thread_is_tracing(): @@ -2193,9 +2256,27 @@ def __rlshift__(self, other: Any) -> Any: def __rrshift__(self, other: Any) -> Any: return self._syft_output_action_object(self.__rrshift__(other)) + # Custom Hash Function for ActionObject + # hash([id, syft_action_data]) + def hash( + self, + recalculate: bool = False, + context: AuthedServiceContext | TransformContext | None = None, + ) -> str: + if not recalculate and self.syft_action_data_hash: + logging.info("Loading cached hash") + return self.syft_action_data_hash + + hash_items = [self.id, self.syft_action_data] + hash_bytes = serialize(hash_items, to_bytes=True) + hash_str = hashlib.sha256(hash_bytes).hexdigest() + self.syft_action_data_hash = hash_str + + return self.syft_action_data_hash + @serializable() -class AnyActionObject(ActionObject): +class AnyActionObjectV1(ActionObjectV1): """ This is a catch-all class for all objects that are not defined in the `action_types` dictionary. @@ -2209,6 +2290,22 @@ class AnyActionObject(ActionObject): syft_dont_wrap_attrs: list[str] = ["__str__", "__repr__", "syft_action_data_str_"] syft_action_data_str_: str = "" + +@serializable() +class AnyActionObject(ActionObject): + """ + This is a catch-all class for all objects that are not + defined in the `action_types` dictionary. + """ + + __canonical_name__ = "AnyActionObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type[Any]] = NoneType # type: ignore + # syft_passthrough_attrs: List[str] = [] + syft_dont_wrap_attrs: list[str] = ["__str__", "__repr__", "syft_action_data_str_"] + syft_action_data_str_: str = "" + def __float__(self) -> float: return float(self.syft_action_data) diff --git a/packages/syft/src/syft/service/action/action_service.py b/packages/syft/src/syft/service/action/action_service.py index ab82c80a2b8..b5361968ad1 100644 --- a/packages/syft/src/syft/service/action/action_service.py +++ b/packages/syft/src/syft/service/action/action_service.py @@ -24,6 +24,7 @@ from ..policy.policy import OutputPolicy from ..policy.policy import retrieve_from_db from ..response import SyftError +from ..response import SyftException from ..response import SyftSuccess from ..response import SyftWarning from ..service import AbstractService @@ -153,6 +154,12 @@ def _set( # 🟡 TODO 9: Create some kind of type checking / protocol for SyftSerializable if isinstance(action_object, ActionObject): + # Always recalculate the hash when saving + # at the server side + # Some objects like Model Ref require context to hash + # NOTE: should be placed before clear cache + action_object.hash(recalculate=True, context=context) # type: ignore + action_object.syft_created_at = DateTime.now() ( action_object._clear_cache() @@ -163,6 +170,10 @@ def _set( action_object.private_obj.syft_created_at = DateTime.now() # type: ignore[unreachable] action_object.mock_obj.syft_created_at = DateTime.now() + # Compute Hash + action_object.private_obj.hash(recalculate=True, context=context) + action_object.mock_obj.hash(recalculate=True, context=context) + # Clear cache if data is saved to blob storage ( action_object.private_obj._clear_cache() @@ -357,6 +368,21 @@ def get_mock( return result.ok() return SyftError(message=result.err()) + # TODO: fix this Tech Debt, currently , we do not have a way to add + # ActionPermission.ALL_READ to the permissions + # Like we have for stashes (document store) + # This is a temporary fix to allow the user to get the model code + @service_method( + path="action.get_model_code", name="get_model_code", roles=GUEST_ROLE_LEVEL + ) + def get_model_code( + self, context: AuthedServiceContext, uid: UID + ) -> Result[SyftError, SyftObject]: + result = self.store.get_model_code(uid=uid) + if result.is_ok(): + return result.ok() + return SyftError(message=result.err()) + @service_method( path="action.has_storage_permission", name="has_storage_permission", @@ -446,7 +472,10 @@ def _user_code_execute( # no twins # allow python types from inputpolicy filtered_kwargs = filter_twin_kwargs( - real_kwargs, twin_mode=TwinMode.NONE, allow_python_types=True + real_kwargs, + twin_mode=TwinMode.NONE, + allow_python_types=True, + context=context, ) exec_result = execute_byte_code(code_item, filtered_kwargs, context) if output_policy: @@ -466,7 +495,10 @@ def _user_code_execute( else: # twins private_kwargs = filter_twin_kwargs( - real_kwargs, twin_mode=TwinMode.PRIVATE, allow_python_types=True + real_kwargs, + twin_mode=TwinMode.PRIVATE, + allow_python_types=True, + context=context, ) private_exec_result = execute_byte_code( code_item, private_kwargs, context @@ -484,7 +516,10 @@ def _user_code_execute( ) mock_kwargs = filter_twin_kwargs( - real_kwargs, twin_mode=TwinMode.MOCK, allow_python_types=True + real_kwargs, + twin_mode=TwinMode.MOCK, + allow_python_types=True, + context=context, ) # relative from .action_data_empty import ActionDataEmpty @@ -940,6 +975,20 @@ def exists( else: return SyftError(message=f"Object: {obj_id} does not exist") + @service_method(path="action.get_hash", name="get_hash", roles=GUEST_ROLE_LEVEL) + def get_hash( + self, context: AuthedServiceContext, obj_id: UID + ) -> Result[SyftSuccess, SyftError]: + """Returns the hash of the given object id in the Action Store""" + # TODO: This is a minor fix, which allows any user + # to get the hash of any object in the Action Store + # will be fixed in the future, with new permissions system + root_context = context.as_root_context() + action_obj = self.get(root_context, obj_id) + if action_obj.is_err(): + return SyftError(message=action_obj.err()) + return action_obj.ok().hash(context=context) + @service_method(path="action.delete", name="delete", roles=ADMIN_ROLE_LEVEL) def delete( self, context: AuthedServiceContext, uid: UID, soft_delete: bool = False @@ -1151,7 +1200,6 @@ def _get_target_callable(path: str, op: str) -> Any: ) except Exception as e: - print("what is this exception", e) return Err(e) return Ok(result_action_object) @@ -1259,8 +1307,14 @@ def filter_twin_args(args: list[Any], twin_mode: TwinMode) -> Any: def filter_twin_kwargs( - kwargs: dict, twin_mode: TwinMode, allow_python_types: bool = False + kwargs: dict, + twin_mode: TwinMode, + allow_python_types: bool = False, + context: AuthedServiceContext | None = None, ) -> Any: + # relative + from ..model.model import ModelRef + filtered = {} for k, v in kwargs.items(): if isinstance(v, TwinObject): @@ -1274,7 +1328,12 @@ def filter_twin_kwargs( ) else: if isinstance(v, ActionObject): - filtered[k] = v.syft_action_data + if type(v) == ModelRef: + if not context: + raise SyftException("ModelRef requires context to be passed") + filtered[k] = v.load_model(context) + else: + filtered[k] = v.syft_action_data elif ( isinstance(v, str | int | float | dict | CustomEndpointActionObject) and allow_python_types diff --git a/packages/syft/src/syft/service/action/action_store.py b/packages/syft/src/syft/service/action/action_store.py index 250b3c5e9b5..951782d1779 100644 --- a/packages/syft/src/syft/service/action/action_store.py +++ b/packages/syft/src/syft/service/action/action_store.py @@ -113,6 +113,20 @@ def get_mock(self, uid: UID) -> Result[SyftObject, str]: except Exception as e: return Err(f"Could not find item with uid {uid}, {e}") + def get_model_code(self, uid: UID) -> Result[SyftObject, str]: + # relative + from ..model.model import SubmitModelCode + + uid = uid.id # We only need the UID from LineageID or UID + + try: + syft_object = self.data[uid] + if isinstance(syft_object, SubmitModelCode): + return Ok(syft_object) + return Err("No SubmitModelCode in Store") + except Exception as e: + return Err(f"Could not find item with uid {uid}, {e}") + def get_pointer( self, uid: UID, diff --git a/packages/syft/src/syft/service/action/numpy.py b/packages/syft/src/syft/service/action/numpy.py index 1949eeb0575..57615090a36 100644 --- a/packages/syft/src/syft/service/action/numpy.py +++ b/packages/syft/src/syft/service/action/numpy.py @@ -9,8 +9,10 @@ # relative from ...serde.serializable import serializable from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from .action_object import ActionObject from .action_object import ActionObjectPointer +from .action_object import ActionObjectV1 from .action_object import BASE_PASSTHROUGH_ATTRS from .action_types import action_types @@ -43,7 +45,7 @@ def numpy_like_eq(left: Any, right: Any) -> bool: @serializable() -class NumpyArrayObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): +class NumpyArrayObjectV1(ActionObjectV1, np.lib.mixins.NDArrayOperatorsMixin): __canonical_name__ = "NumpyArrayObject" __version__ = SYFT_OBJECT_VERSION_1 @@ -52,6 +54,17 @@ class NumpyArrayObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] + +@serializable() +class NumpyArrayObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): + __canonical_name__ = "NumpyArrayObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type[Any]] = np.ndarray + syft_pointer_type: ClassVar[type[ActionObjectPointer]] = NumpyArrayObjectPointer + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] + # def __eq__(self, other: Any) -> bool: # # 🟡 TODO 8: move __eq__ to a Data / Serdeable type interface on ActionObject # if isinstance(other, NumpyArrayObject): @@ -86,7 +99,7 @@ def __array_ufunc__( @serializable() -class NumpyScalarObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): +class NumpyScalarObjectV1(ActionObjectV1, np.lib.mixins.NDArrayOperatorsMixin): __canonical_name__ = "NumpyScalarObject" __version__ = SYFT_OBJECT_VERSION_1 @@ -94,12 +107,22 @@ class NumpyScalarObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] + +@serializable() +class NumpyScalarObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): + __canonical_name__ = "NumpyScalarObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type] = np.number + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] + def __float__(self) -> float: return float(self.syft_action_data) @serializable() -class NumpyBoolObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): +class NumpyBoolObjectV1(ActionObjectV1, np.lib.mixins.NDArrayOperatorsMixin): __canonical_name__ = "NumpyBoolObject" __version__ = SYFT_OBJECT_VERSION_1 @@ -108,6 +131,16 @@ class NumpyBoolObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] +@serializable() +class NumpyBoolObject(ActionObject, np.lib.mixins.NDArrayOperatorsMixin): + __canonical_name__ = "NumpyBoolObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type] = np.bool_ + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + syft_dont_wrap_attrs: list[str] = ["dtype", "shape"] + + np_array = np.array([1, 2, 3]) action_types[type(np_array)] = NumpyArrayObject diff --git a/packages/syft/src/syft/service/action/pandas.py b/packages/syft/src/syft/service/action/pandas.py index 9de480ddd0f..a0a7ff2d90b 100644 --- a/packages/syft/src/syft/service/action/pandas.py +++ b/packages/syft/src/syft/service/action/pandas.py @@ -9,18 +9,29 @@ # relative from ...serde.serializable import serializable from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from .action_object import ActionObject +from .action_object import ActionObjectV1 from .action_object import BASE_PASSTHROUGH_ATTRS from .action_types import action_types @serializable() -class PandasDataFrameObject(ActionObject): +class PandasDataFrameObjectV1(ActionObjectV1): __canonical_name__ = "PandasDataframeObject" __version__ = SYFT_OBJECT_VERSION_1 syft_internal_type: ClassVar[type] = DataFrame syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + + +@serializable() +class PandasDataFrameObject(ActionObject): + __canonical_name__ = "PandasDataframeObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type] = DataFrame + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS # this is added for instance checks for dataframes # syft_dont_wrap_attrs = ["shape"] @@ -46,13 +57,22 @@ def __bool__(self) -> bool: @serializable() -class PandasSeriesObject(ActionObject): +class PandasSeriesObjectV1(ActionObjectV1): __canonical_name__ = "PandasSeriesObject" __version__ = SYFT_OBJECT_VERSION_1 syft_internal_type = Series syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + +@serializable() +class PandasSeriesObject(ActionObject): + __canonical_name__ = "PandasSeriesObject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type = Series + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + # name: Optional[str] = None # syft_dont_wrap_attrs = ["shape"] diff --git a/packages/syft/src/syft/service/attestation/attestation_cpu_report.py b/packages/syft/src/syft/service/attestation/attestation_cpu_report.py new file mode 100644 index 00000000000..f60d35dab40 --- /dev/null +++ b/packages/syft/src/syft/service/attestation/attestation_cpu_report.py @@ -0,0 +1,180 @@ +# stdlib +import time +from typing import Any + +CPU_ATTESTATION_SUMMARY_TEMPLATE = """ +----------------------------------------------------------- +📝 Attestation Report Summary +----------------------------------------------------------- +Issued At: {Issued At} +Valid From: {Valid From} +Expiry: {Expiry} (Token expires in: {Remaining Time}) + +📢 Issuer Information +----------------------------------------------------------- +Issuer: {Issuer} +Attestation Type: {Attestation Type} +VM ID: {VM ID} + +🔒 Security Features +----------------------------------------------------------- +Secure Boot: {Secure Boot} +Boot Debugging: {Boot Debugging} +Debuggers Disabled: {Debuggers Disabled} +Kernel Debugging: {Kernel Debugging} +Hypervisor Debugging: {Hypervisor Debugging} +Signing Disabled: {Signing Disabled} +Test Signing: {Test Signing} + +💻 Operating System +----------------------------------------------------------- +OS Type: {OS Type} +OS Distro: {OS Distro} +OS Version: {OS Version} + +🛡️ Compliance and Validation +----------------------------------------------------------- +PCRs Attested: {PCRs Attested} +DB Validation: {DB Validation} +DBX Validation: {DBX Validation} +Default Secure Boot Keys Validated: {Default Secure Boot Keys Validated} +Compliance Status: {Compliance Status} + +🔐 Isolation Environment +----------------------------------------------------------- +Isolation Type: {Isolation Type} +Author Key Digest: {Author Key Digest} +Launch Measurement: {Launch Measurement} +Debuggability: {Debuggability} +Migration Allowed: {Migration Allowed} +----------------------------------------------------------- +""" + + +class CPUAttestationReport: + def __init__(self, report: dict[str, Any]) -> None: + self.report = report + self.expected_values = { + "secureboot": True, + "x-ms-azurevm-bootdebug-enabled": False, + "x-ms-azurevm-debuggersdisabled": True, + "x-ms-azurevm-kerneldebug-enabled": False, + "x-ms-azurevm-hypervisordebug-enabled": False, + "x-ms-azurevm-signingdisabled": True, + "x-ms-azurevm-testsigning-enabled": False, + "x-ms-azurevm-dbvalidated": True, + "x-ms-azurevm-dbxvalidated": True, + "x-ms-azurevm-default-securebootkeysvalidated": True, + "x-ms-isolation-tee.x-ms-sevsnpvm-is-debuggable": False, + "x-ms-isolation-tee.x-ms-sevsnpvm-migration-allowed": False, + } + + def check(self, field_name: str) -> Any: + actual_value = self.get_nested_value(self.report, field_name) + expected_value = self.expected_values.get(field_name, None) + return actual_value == expected_value + + def status(self, field_name: str) -> str: + return "✅" if self.check(field_name) else "❌" + + def is_secure(self) -> bool: + return all(self.check(field_name) for field_name in self.expected_values.keys()) + + def get_nested_value(self, data: dict, key: str) -> Any: + keys = key.split(".") + for k in keys: + data = data.get(k, {}) + return data + + def generate_summary(self) -> str: + attestation_summary = { + "Issued At": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["iat"]) + ), + "Valid From": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["nbf"]) + ), + "Expiry": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["exp"]) + ), + "Issuer": self.report["iss"], + "Remaining Time": time.strftime( + "%H:%M:%S", time.gmtime(self.report["exp"] - int(time.time())) + ) + if time.time() < self.report["exp"] + else "Expired ❌", + "Attestation Type": self.report["x-ms-attestation-type"], + "VM ID": self.report["x-ms-azurevm-vmid"], + "Secure Boot": ( + f"{self.status('secureboot')} " + f"{'Enabled' if self.report['secureboot'] else 'Disabled'}" + ), + "Boot Debugging": ( + f"{self.status('x-ms-azurevm-bootdebug-enabled')} " + f"{'Enabled' if self.report['x-ms-azurevm-bootdebug-enabled'] else 'Disabled'}" + ), + "Debuggers Disabled": ( + f"{self.status('x-ms-azurevm-debuggersdisabled')} " + f"{'Yes' if self.report['x-ms-azurevm-debuggersdisabled'] else 'No'}" + ), + "Kernel Debugging": ( + f"{self.status('x-ms-azurevm-kerneldebug-enabled')} " + f"{'Enabled' if self.report['x-ms-azurevm-kerneldebug-enabled'] else 'Disabled'}" + ), + "Hypervisor Debugging": ( + f"{self.status('x-ms-azurevm-hypervisordebug-enabled')} " + f"{'Enabled' if self.report['x-ms-azurevm-hypervisordebug-enabled'] else 'Disabled'}" + ), + "Signing Disabled": ( + f"{self.status('x-ms-azurevm-signingdisabled')} " + f"{'Yes' if self.report['x-ms-azurevm-signingdisabled'] else 'No'}" + ), + "Test Signing": ( + f"{self.status('x-ms-azurevm-testsigning-enabled')} " + f"{'Enabled' if self.report['x-ms-azurevm-testsigning-enabled'] else 'Disabled'}" + ), + "OS Type": self.report["x-ms-azurevm-ostype"].capitalize(), + "OS Distro": self.report["x-ms-azurevm-osdistro"], + "OS Version": ( + f"{self.report['x-ms-azurevm-osversion-major']}." + f"{self.report['x-ms-azurevm-osversion-minor']}" + ), + "PCRs Attested": ", ".join( + map(str, self.report["x-ms-azurevm-attested-pcrs"]) + ), + "DB Validation": ( + f"{self.status('x-ms-azurevm-dbvalidated')} " + f"{'Valid' if self.report['x-ms-azurevm-dbvalidated'] else 'Invalid'}" + ), + "DBX Validation": ( + f"{self.status('x-ms-azurevm-dbxvalidated')} " + f"{'Valid' if self.report['x-ms-azurevm-dbxvalidated'] else 'Invalid'}" + ), + "Default Secure Boot Keys Validated": ( + f"{self.status('x-ms-azurevm-default-securebootkeysvalidated')} " + f"{'Yes' if self.report['x-ms-azurevm-default-securebootkeysvalidated'] else 'No'}" + ), + "Compliance Status": ( + self.report["x-ms-isolation-tee"]["x-ms-compliance-status"] + .replace("-", " ") + .capitalize() + ), + "Isolation Type": ( + self.report["x-ms-isolation-tee"]["x-ms-attestation-type"].upper() + ), + "Author Key Digest": ( + self.report["x-ms-isolation-tee"]["x-ms-sevsnpvm-authorkeydigest"] + ), + "Launch Measurement": ( + self.report["x-ms-isolation-tee"]["x-ms-sevsnpvm-launchmeasurement"] + ), + "Debuggability": ( + f"{self.status('x-ms-isolation-tee.x-ms-sevsnpvm-is-debuggable')} " + f"{'Yes' if self.report['x-ms-isolation-tee']['x-ms-sevsnpvm-is-debuggable'] else 'No'}" + ), + "Migration Allowed": ( + f"{self.status('x-ms-isolation-tee.x-ms-sevsnpvm-migration-allowed')} " + f"{'Yes' if self.report['x-ms-isolation-tee']['x-ms-sevsnpvm-migration-allowed'] else 'No'}" + ), + } + return CPU_ATTESTATION_SUMMARY_TEMPLATE.format(**attestation_summary) diff --git a/packages/syft/src/syft/service/attestation/attestation_gpu_report.py b/packages/syft/src/syft/service/attestation/attestation_gpu_report.py new file mode 100644 index 00000000000..49957553119 --- /dev/null +++ b/packages/syft/src/syft/service/attestation/attestation_gpu_report.py @@ -0,0 +1,90 @@ +# stdlib +import time +from typing import Any + +GPU_ATTESTATION_SUMMARY_TEMPLATE = """ +----------------------------------------------------------- +📝 Attestation Report Summary +----------------------------------------------------------- +Issued At: {Issued At} +Valid From: {Valid From} +Expiry: {Expiry} (Token expires in: {Remaining Time}) + +📢 Issuer Information +----------------------------------------------------------- +Issuer: {Issuer} +Attestation Type: {Attestation Type} +Device ID: {Device ID} + +🔒 Security Features +----------------------------------------------------------- +Secure Boot: {Secure Boot} +Debugging: {Debugging} + +💻 Hardware +----------------------------------------------------------- +HW Model : {HW Model} +OEM ID: {OEM ID} +Driver Version: {Driver Version} +VBIOS Version: {VBIOS Version} +""" + + +class GPUAttestationReport: + def __init__(self, report: dict[str, Any]) -> None: + self.report = report + self.expected_values = { + "secboot": True, + "dbgstat": "disabled", + } + + def check(self, field_name: str) -> Any: + actual_value = self.get_nested_value(self.report, field_name) + expected_value = self.expected_values.get(field_name, None) + return actual_value == expected_value + + def status(self, field_name: str) -> str: + return "✅" if self.check(field_name) else "❌" + + def is_secure(self) -> bool: + return all(self.check(field_name) for field_name in self.expected_values.keys()) + + def get_nested_value(self, data: dict, key: str) -> Any: + keys = key.split(".") + for k in keys: + data = data.get(k, {}) + return data + + def generate_summary(self) -> str: + attestation_summary = { + "Issued At": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["iat"]) + ), + "Valid From": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["nbf"]) + ), + "Expiry": time.strftime( + "%Y-%m-%d %H:%M:%S", time.gmtime(self.report["exp"]) + ), + "Issuer": self.report["iss"], + "Remaining Time": time.strftime( + "%H:%M:%S", time.gmtime(self.report["exp"] - int(time.time())) + ) + if time.time() < self.report["exp"] + else "Expired ❌", + "Attestation Type": self.report["x-nvidia-attestation-type"], + "Device ID": self.report["ueid"], + "Secure Boot": ( + f"{self.status('secboot')} " + f"{'Enabled' if self.report['secboot'] else 'Disabled'}" + ), + "Debugging": ( + f"{self.status('dbgstat')} " + f"{'Enabled' if self.report['dbgstat'] == 'enabled' else 'Disabled'}" + ), + "HW Model": self.report["hwmodel"], + "OEM ID": self.report["oemid"], + "Driver Version": self.report["x-nvidia-gpu-driver-version"], + "VBIOS Version": self.report["x-nvidia-gpu-vbios-version"], + } + return GPU_ATTESTATION_SUMMARY_TEMPLATE.format(**attestation_summary) diff --git a/packages/syft/src/syft/service/attestation/attestation_mock_cpu_report.py b/packages/syft/src/syft/service/attestation/attestation_mock_cpu_report.py new file mode 100644 index 00000000000..5b5374dd374 --- /dev/null +++ b/packages/syft/src/syft/service/attestation/attestation_mock_cpu_report.py @@ -0,0 +1,55 @@ +CPU_MOCK_REPORT = ( + "eyJhbGciOiJSUzI1NiIsImprdSI6Imh0dHBzOi8vc2hhcmVkZXVzMi5ldXMyLmF0dGVzdC5henVyZS5uZXQvY2VydHMiLCJraWQi" + "OiJKMHBBUGRmWFhIcVdXaW1nckg4NTN3TUlkaDUvZkxlMXo2dVNYWVBYQ2EwPSIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MjI5NjQ0ODQsImlhdCI6M" + "TcyMjkzNTY4NCwiaXNzIjoiaHR0cHM6Ly9zaGFyZWRldXMyLmV1czIuYXR0ZXN0LmF6dXJlLm5ldCIsImp0aSI6IjVjZDdiM2Y0OGU0ODExYzYxZjB" + "mNDdkMjExM2QwOTc3ZmNhODZkOTZmMjlkNjM3MjIwYzFkZGFlOTdlYmVkNWEiLCJuYmYiOjE3MjI5MzU2ODQsInNlY3VyZWJvb3QiOnRydWUsIngtb" + "XMtYXR0ZXN0YXRpb24tdHlwZSI6ImF6dXJldm0iLCJ4LW1zLWF6dXJldm0tYXR0ZXN0YXRpb24tcHJvdG9jb2wtdmVyIjoiMi4wIiwieC1tcy1henV" + "yZXZtLWF0dGVzdGVkLXBjcnMiOlswLDEsMiwzLDQsNSw2LDddLCJ4LW1zLWF6dXJldm0tYm9vdGRlYnVnLWVuYWJsZWQiOmZhbHNlLCJ4LW1zLWF6d" + "XJldm0tZGJ2YWxpZGF0ZWQiOnRydWUsIngtbXMtYXp1cmV2bS1kYnh2YWxpZGF0ZWQiOnRydWUsIngtbXMtYXp1cmV2bS1kZWJ1Z2dlcnNkaXNhYmx" + "lZCI6dHJ1ZSwieC1tcy1henVyZXZtLWRlZmF1bHQtc2VjdXJlYm9vdGtleXN2YWxpZGF0ZWQiOnRydWUsIngtbXMtYXp1cmV2bS1lbGFtLWVuYWJsZ" + "WQiOmZhbHNlLCJ4LW1zLWF6dXJldm0tZmxpZ2h0c2lnbmluZy1lbmFibGVkIjpmYWxzZSwieC1tcy1henVyZXZtLWh2Y2ktcG9saWN5IjowLCJ4LW1" + "zLWF6dXJldm0taHlwZXJ2aXNvcmRlYnVnLWVuYWJsZWQiOmZhbHNlLCJ4LW1zLWF6dXJldm0taXMtd2luZG93cyI6ZmFsc2UsIngtbXMtYXp1cmV2b" + "S1rZXJuZWxkZWJ1Zy1lbmFibGVkIjpmYWxzZSwieC1tcy1henVyZXZtLW9zYnVpbGQiOiJOb3RBcHBsaWNhdGlvbiIsIngtbXMtYXp1cmV2bS1vc2R" + "pc3RybyI6IkRlYmlhbiBHTlUvTGludXgiLCJ4LW1zLWF6dXJldm0tb3N0eXBlIjoiTGludXgiLCJ4LW1zLWF6dXJldm0tb3N2ZXJzaW9uLW1ham9yI" + "joxMiwieC1tcy1henVyZXZtLW9zdmVyc2lvbi1taW5vciI6MCwieC1tcy1henVyZXZtLXNpZ25pbmdkaXNhYmxlZCI6dHJ1ZSwieC1tcy1henVyZXZ" + "tLXRlc3RzaWduaW5nLWVuYWJsZWQiOmZhbHNlLCJ4LW1zLWF6dXJldm0tdm1pZCI6IjA3QkM4Mjk0LUI4OUYtNEQ4MC04QzgxLTU4MDgxMThFQjJCQ" + "yIsIngtbXMtaXNvbGF0aW9uLXRlZSI6eyJ4LW1zLWF0dGVzdGF0aW9uLXR5cGUiOiJzZXZzbnB2bSIsIngtbXMtY29tcGxpYW5jZS1zdGF0dXMiOiJ" + "henVyZS1jb21wbGlhbnQtY3ZtIiwieC1tcy1ydW50aW1lIjp7ImtleXMiOlt7ImUiOiJBUUFCIiwia2V5X29wcyI6WyJzaWduIl0sImtpZCI6IkhDT" + "EFrUHViIiwia3R5IjoiUlNBIiwibiI6IjNWaGpkUUFBb3dTSkFXZVFWekY1Yl81QnBFbXNtdFcwdVQtaU5ycVNaVnpZR2k0WkJJUl9Ta3NVa29ybXV" + "OY2lZdEctZF9XRmxYRk92SU8yblI2LUo1OFZEOExtOUpZSEZzbDZzOXcyOUFXZml6UHlkcmJGOFhRM1czV3VOSGllUUFCTWE4N2VTSnZia2dCRzd5N" + "XpKQXl4VTZ5MVFWbWZJa2t5ZVQ1VUVZMXp2SnZMT3lKZ0xEUmpicGRZY2hSTWZYaTNrSFc3S08xLWZOeDVidW9sZzJpSFY5cm9ha0tBYmoxdGk3Yy1" + "1UDM4TGpvQjNqX28zZDFPelhvVkNvX2hMWjZJZzMzdFhhYTBBMEJocHFGb3ZCSk1qbDZ3aVVFVGxLMkZIem1vWHdnYUJEV1NjS2RNZ2xGT1EtQURLY" + "m9JcU1tWVZtQlBaUTFVZjlXOTRDY1RQUSJ9LHsiZSI6IkFRQUIiLCJrZXlfb3BzIjpbImVuY3J5cHQiXSwia2lkIjoiSENMRWtQdWIiLCJrdHkiOiJ" + "SU0EiLCJuIjoidXYyS1dnQUFTWDVWeUlFYl9aZWVPam14NFlDZWFnN1NKNjhDR24xOTRZTmd1bVA3WUFCTjR5cktKRWtGVWo2d1JlOGdoREFHNlNxc" + "WQtTHkxUHBmd2lZNklQZnphZWM5dm9KSXRPWFdiS0tLQzV0ZlU4SDNmXzVyeW5ZSlRNdlg1cGdzbkFrLVBxbW40OWY2ZlJjM056SHlBdnJKcUVhLWV" + "RSDdpQ2ViSzdzckpwZzFoZy1ySjZEcGx4bTZudkhSVkVtWXRPd0tUcmdFZ29NdkVscWt1MGhOUG8wZV9RNElsYVpxR2JfRy1SZmdnR3pRaWpnMFl5V" + "TZLZFNJMzg3V0JSSUxlNFNoVVBsSmk2WkRVVDlPSkRRa3NSWGk4Y05pZTdVM0ZRQzFVVEpMRkFtenR3cDFsNU05bHlyLVRIMS1XV0loMk1oajZYOFV" + "ILXR5QUllMWZ3In1dLCJ1c2VyLWRhdGEiOiIwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwM" + "DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsInZtLWNvbmZpZ3VyYXR" + "pb24iOnsiY29uc29sZS1lbmFibGVkIjp0cnVlLCJyb290LWNlcnQtdGh1bWJwcmludCI6IjZuWlpuWWFKYzRLcVVaX3l2QS1tdWNGZFlOb3V2bFBuS" + "VRuTk1Yc0hsLTAiLCJzZWN1cmUtYm9vdCI6dHJ1ZSwidHBtLWVuYWJsZWQiOnRydWUsInRwbS1wZXJzaXN0ZWQiOnRydWUsInZtVW5pcXVlSWQiOiI" + "wN0JDODI5NC1CODlGLTREODAtOEM4MS01ODA4MTE4RUIyQkMifX0sIngtbXMtc2V2c25wdm0tYXV0aG9ya2V5ZGlnZXN0IjoiMDAwMDAwMDAwMDAwM" + "DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiw" + "ieC1tcy1zZXZzbnB2bS1ib290bG9hZGVyLXN2biI6OCwieC1tcy1zZXZzbnB2bS1mYW1pbHlJZCI6IjAxMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwM" + "DAwMDAwIiwieC1tcy1zZXZzbnB2bS1ndWVzdHN2biI6NjU1NDMsIngtbXMtc2V2c25wdm0taG9zdGRhdGEiOiIwMDAwMDAwMDAwMDAwMDAwMDAwMDA" + "wMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiwieC1tcy1zZXZzbnB2bS1pZGtleWRpZ2VzdCI6IjAzNTYyMTU4ODJhO" + "DI1Mjc5YTg1YjMwMGIwYjc0MjkzMWQxMTNiZjdlMzJkZGUyZTUwZmZkZTdlYzc0M2NhNDkxZWNkZDdmMzM2ZGMyOGE2ZTBiMmJiNTdhZjdhNDRhMyI" + "sIngtbXMtc2V2c25wdm0taW1hZ2VJZCI6IjAyMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiwieC1tcy1zZXZzbnB2bS1pcy1kZWJ1Z2dhY" + "mxlIjpmYWxzZSwieC1tcy1zZXZzbnB2bS1sYXVuY2htZWFzdXJlbWVudCI6IjFjMDYyNjJmM2Y5YjQ0ODBlZDg3MDRiY2Q1NWU5M2IxMTU2ZjMxMTR" + "iMjgzZWM4ZjE0MzVlMTA4OWM5MjM0NDU1NDFmMTY1NzBhM2JkZDBmM2E5ODA0M2ViNmVhYmMwYiIsIngtbXMtc2V2c25wdm0tbWljcm9jb2RlLXN2b" + "iI6NjgsIngtbXMtc2V2c25wdm0tbWlncmF0aW9uLWFsbG93ZWQiOmZhbHNlLCJ4LW1zLXNldnNucHZtLXJlcG9ydGRhdGEiOiJhMjZhM2U5NGU1NjA" + "2ODJmY2I2YmQ1Mjg2MGVlMGJjM2Y3YWIwZTVlMzQyOGJiZTVmOGU5M2Y3YjJmZWE2NGQyMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwM" + "DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsIngtbXMtc2V2c25wdm0tcmVwb3J0aWQiOiI3OWIxMzUxYTNiNDA4ZjIxYTM5YTZiNzA5MTB" + "lZDI1ZjJiOTMyMmU1YTZiMzU1ZGI4NzdhNjM3YjcwNjhkZjgzIiwieC1tcy1zZXZzbnB2bS1zbXQtYWxsb3dlZCI6dHJ1ZSwieC1tcy1zZXZzbnB2b" + "S1zbnBmdy1zdm4iOjE2LCJ4LW1zLXNldnNucHZtLXRlZS1zdm4iOjAsIngtbXMtc2V2c25wdm0tdm1wbCI6MH0sIngtbXMtcG9saWN5LWhhc2giOiJ" + "3bTltSGx2VFU4MmU4VXFvT3kxWWoxRkJSU05rZmU5OS02OUlZRHE5ZVdzIiwieC1tcy1ydW50aW1lIjp7ImNsaWVudC1wYXlsb2FkIjp7Im5vbmNlI" + "joiIn0sImtleXMiOlt7ImUiOiJBUUFCIiwia2V5X29wcyI6WyJlbmNyeXB0Il0sImtpZCI6IlRwbUVwaGVtZXJhbEVuY3J5cHRpb25LZXkiLCJrdHk" + "iOiJSU0EiLCJuIjoicm1WcEFBQUF0NXZXTFRRX01ucjl3MUl2Ni1qb2lDOGtxVTVYWUV0M29VQ2l4aTd6eFVCOHVFOGkzWkttV1ljWDRaN19uN0F6N" + "UV5TGpIempSSENsUDcwTTViOHpBZFNHRGhKQUN3S1BzNlZzc18zSjBqWnNhYmxqUXprWEJhSWZlUmhKQnpEcVoyRGJnTzJLTUhiWTM1b2dodlp1SHB" + "qc1FuNTJIY19jSi1sa0w3cDFOaWl3aDVhSmlsYzhUY2ZfRTgxOG81RDlUZFdOV1VGTktRVzVaVEVIbnJ5VWI1a3ZJeGxuOVgzb3JaYWhlUUFRUzdoe" + "DlzYUZUSExJVnlwZm5FMW16MWl0UlM3S0JOMTZvNFFaVUhraXZuMktKSnZFRXNyN21mSm5vSXpJV0JGYWVlU05jNXZURHFuVW92eGNuNUotOENQeWx" + "1cDVkNU1DWHR3RGR3In1dfSwieC1tcy12ZXIiOiIxLjAifQ.lO8dqJPVEv82w2m8nqpD7aBgjyj0BZppHRULfoLN5hRfB9GQSDk6iUTwEDlQHVLyNc" + "V4MKlsJXvYfC8YZspFQcV_5HBghnkCLIrJsvaWpIF8jJ-LLSX-F-X7xk6H_vqNgO3DTrMgmwOXFZb1i7ar_GkM4BOF7dgTZPz4YMkDBxacdbh-5vc1" + "qOKGKw4EWLm_8Jdgni9OHnlWOpnXNlznXgKFqGinBvjME72Acx4gxWUWMR1CLogqhKAmnYo9Bc9Cw4EZ-qUEHm8YqkCoRXbQbUEpJZAz2kJBkkdWXQ" + "Lb2VAU5y8E9sB7oAGuSUyibzHJqQkcpSuj3WNorEQYp7v90w" +) diff --git a/packages/syft/src/syft/service/attestation/attestation_mock_gpu_report.py b/packages/syft/src/syft/service/attestation/attestation_mock_gpu_report.py new file mode 100644 index 00000000000..0f7b2087629 --- /dev/null +++ b/packages/syft/src/syft/service/attestation/attestation_mock_gpu_report.py @@ -0,0 +1,22 @@ +GPU_MOCK_REPORT = ( + "eyJraWQiOiJudi1lYXQta2lkLXByb2QtMjAyNDA4MTIwMTEwMDQ0NTItYTM5NTMwNzYtZjc0Ni00MmViLTkzNjItYmY0OTBiYTM4OWJmIiwiYWxnI" + "joiRVMzODQifQ.eyJzdWIiOiJOVklESUEtR1BVLUFUVEVTVEFUSU9OIiwic2VjYm9vdCI6dHJ1ZSwieC1udmlkaWEtZ3B1LW1hbnVmYWN0dXJlciI" + "6Ik5WSURJQSBDb3Jwb3JhdGlvbiIsIngtbnZpZGlhLWF0dGVzdGF0aW9uLXR5cGUiOiJHUFUiLCJpc3MiOiJodHRwczovL25yYXMuYXR0ZXN0YXRp" + "b24ubnZpZGlhLmNvbSIsImVhdF9ub25jZSI6IjEyODY0MDA2ODQyRDMwNjFDOUQ5QUI1NTc2NjUxRjI5RDdEN0QzMDk2NzdEMkRFRTQyRDgyMjc5M" + "TMzNTFDREIiLCJ4LW52aWRpYS1hdHRlc3RhdGlvbi1kZXRhaWxlZC1yZXN1bHQiOnsieC1udmlkaWEtZ3B1LWRyaXZlci1yaW0tc2NoZW1hLXZhbG" + "lkYXRlZCI6dHJ1ZSwieC1udmlkaWEtZ3B1LXZiaW9zLXJpbS1jZXJ0LXZhbGlkYXRlZCI6dHJ1ZSwieC1udmlkaWEtZ3B1LWF0dGVzdGF0aW9uLXJ" + "lcG9ydC1jZXJ0LWNoYWluLXZhbGlkYXRlZCI6dHJ1ZSwieC1udmlkaWEtZ3B1LWRyaXZlci1yaW0tc2NoZW1hLWZldGNoZWQiOnRydWUsIngtbnZp" + "ZGlhLWdwdS1hdHRlc3RhdGlvbi1yZXBvcnQtcGFyc2VkIjp0cnVlLCJ4LW52aWRpYS1ncHUtbm9uY2UtbWF0Y2giOnRydWUsIngtbnZpZGlhLWdwd" + "S12Ymlvcy1yaW0tc2lnbmF0dXJlLXZlcmlmaWVkIjp0cnVlLCJ4LW52aWRpYS1ncHUtZHJpdmVyLXJpbS1zaWduYXR1cmUtdmVyaWZpZWQiOnRydWU" + "sIngtbnZpZGlhLWdwdS1hcmNoLWNoZWNrIjp0cnVlLCJ4LW52aWRpYS1hdHRlc3RhdGlvbi13YXJuaW5nIjpudWxsLCJ4LW52aWRpYS1ncHUtbWVhc" + "3VyZW1lbnRzLW1hdGNoIjp0cnVlLCJ4LW52aWRpYS1ncHUtYXR0ZXN0YXRpb24tcmVwb3J0LXNpZ25hdHVyZS12ZXJpZmllZCI6dHJ1ZSwieC1udml" + "kaWEtZ3B1LXZiaW9zLXJpbS1zY2hlbWEtdmFsaWRhdGVkIjp0cnVlLCJ4LW52aWRpYS1ncHUtZHJpdmVyLXJpbS1jZXJ0LXZhbGlkYXRlZCI6dHJ1" + "ZSwieC1udmlkaWEtZ3B1LXZiaW9zLXJpbS1zY2hlbWEtZmV0Y2hlZCI6dHJ1ZSwieC1udmlkaWEtZ3B1LXZiaW9zLXJpbS1tZWFzdXJlbWVudHMtY" + "XZhaWxhYmxlIjp0cnVlLCJ4LW52aWRpYS1ncHUtZHJpdmVyLXJpbS1kcml2ZXItbWVhc3VyZW1lbnRzLWF2YWlsYWJsZSI6dHJ1ZX0sIngtbnZpZG" + "lhLXZlciI6IjEuMCIsIm5iZiI6MTcyMzQ0MjM4OSwieC1udmlkaWEtZ3B1LWRyaXZlci12ZXJzaW9uIjoiNTM1LjEyOS4wMyIsImRiZ3N0YXQiOiJ" + "kaXNhYmxlZCIsImh3bW9kZWwiOiJHSDEwMCBBMDEgR1NQIEJST00iLCJvZW1pZCI6IjU3MDMiLCJtZWFzcmVzIjoiY29tcGFyaXNvbi1zdWNjZXNz" + "ZnVsIiwiZXhwIjoxNzIzNDQ1OTg5LCJpYXQiOjE3MjM0NDIzODksIngtbnZpZGlhLWVhdC12ZXIiOiJFQVQtMjEiLCJ1ZWlkIjoiNDM0NzY1NzYxNT" + "U5MjU3NzA1ODA1NDI0OTM5MjU0ODg4NTQ2OTg2OTMxMjc3NjYwIiwieC1udmlkaWEtZ3B1LXZiaW9zLXZlcnNpb24iOiI5Ni4wMC44OC4wMC4xMSIs" + "Imp0aSI6ImRiMDAxZGU2LTVlMmQtNGZiMS1iN2ZkLWY2NzY4MDliNjc0MyJ9.lx9Tarzp8r8Dr9qwA0wb2_7KIOFZgBi1Q2I2QcMw4tzAb9RgeTUi" + "cwRvuLW1JNvZYRyfVkt6p9EPQN37RRaeM9yAD2eg9gBke9mXzpgQEQZJee8KScVuUG2rFEExFXfR" +) diff --git a/packages/syft/src/syft/service/attestation/attestation_service.py b/packages/syft/src/syft/service/attestation/attestation_service.py index 87289278bf3..bc9b6b592fa 100644 --- a/packages/syft/src/syft/service/attestation/attestation_service.py +++ b/packages/syft/src/syft/service/attestation/attestation_service.py @@ -17,6 +17,8 @@ from .attestation_constants import ATTESTATION_SERVICE_URL from .attestation_constants import ATTEST_CPU_ENDPOINT from .attestation_constants import ATTEST_GPU_ENDPOINT +from .attestation_mock_cpu_report import CPU_MOCK_REPORT +from .attestation_mock_gpu_report import GPU_MOCK_REPORT @serializable(canonical_name="AttestationService", version=1) @@ -51,8 +53,13 @@ def perform_request( roles=GUEST_ROLE_LEVEL, ) def get_cpu_attestation( - self, context: AuthedServiceContext, raw_token: bool = False + self, + context: AuthedServiceContext, + raw_token: bool = False, + mock_report: bool = False, ) -> str | SyftError | SyftSuccess: + if mock_report: + return CPU_MOCK_REPORT return self.perform_request(requests.get, ATTEST_CPU_ENDPOINT, raw_token) @service_method( @@ -61,6 +68,11 @@ def get_cpu_attestation( roles=GUEST_ROLE_LEVEL, ) def get_gpu_attestation( - self, context: AuthedServiceContext, raw_token: bool = False + self, + context: AuthedServiceContext, + raw_token: bool = False, + mock_report: bool = False, ) -> str | SyftError | SyftSuccess: + if mock_report: + return GPU_MOCK_REPORT return self.perform_request(requests.get, ATTEST_GPU_ENDPOINT, raw_token) diff --git a/packages/syft/src/syft/service/attestation/utils.py b/packages/syft/src/syft/service/attestation/utils.py new file mode 100644 index 00000000000..214c754892a --- /dev/null +++ b/packages/syft/src/syft/service/attestation/utils.py @@ -0,0 +1,104 @@ +# stdlib +import base64 +from enum import Enum + +# third party +from cryptography.x509 import load_der_x509_certificate +import jwt +from jwt.algorithms import RSAAlgorithm +import requests +from result import Err +from result import Ok +from result import Result +from typing_extensions import Self + + +class AttestationType(str, Enum): + # Define enum members with their corresponding JWKS URLs + CPU = "CPU" + GPU = "GPU" + + def __new__(cls, value: str) -> Self: + JWKS_URL_MAP = { + "CPU": "https://sharedeus2.eus2.attest.azure.net/certs", + "GPU": "https://nras.attestation.nvidia.com/.well-known/jwks.json", + } + if value not in JWKS_URL_MAP: + raise ValueError(f"JWKS URL not defined for token type: {value}") + obj = str.__new__(cls, value) + obj._value_ = value + obj.jwks_url = JWKS_URL_MAP.get(value) + return obj + + def __str__(self) -> str: + return self.value + + +def verify_attestation_report( + token: str, + attestation_type: AttestationType = AttestationType.CPU, + verify_expiration: bool = True, +) -> Result[Ok[dict], Err[str]]: + """ + Verifies a JSON Web Token (JWT) using a public key obtained from a JWKS (JSON Web Key Set) endpoint, + based on the specified type of token ('cpu' or 'gpu'). The function handles two distinct processes + for token verification depending on the type specified: + + - 'cpu': Fetches the JWKS from the 'jku' URL specified in the JWT's unverified header, + finds the key by 'kid', and converts the JWK to a PEM format public key for verification. + + - 'gpu': Directly uses a fixed JWKS URL to retrieve the keys, finds the key by 'kid', and uses the + 'x5c' field to extract a certificate which is then used to verify the token. + + Parameters: + token (str): The JWT that needs to be verified. + token_type (AttestationType): The type of token to be verified (CPU or GPU). + + Returns: + Result[Ok[dict], Err[str]]: A Result object containing the payload of the verified token if successful, + or an Err object with an error message if the verification fails. + """ + jwks_url = attestation_type.jwks_url + unverified_header = jwt.get_unverified_header(token) + + try: + # Fetch the JWKS from the endpoint + jwks = requests.get(jwks_url).json() + except Exception as e: + return Err(f"Failed to fetch JWKS: {str(e)}") + + try: + # Get the key ID from the JWT header and find the matching key in the JWKS + kid = unverified_header["kid"] + key = next((item for item in jwks["keys"] if item["kid"] == kid), None) + if not key: + return Err("Public key not found in JWKS list.") + except Exception as e: + return Err(f"Failed to process JWKS: {str(e)}") + + try: + # Convert the key based on the token type + if attestation_type == AttestationType.GPU and "x5c" in key: + cert_bytes = base64.b64decode(key["x5c"][0]) + cert = load_der_x509_certificate(cert_bytes) + public_key = cert.public_key() + elif attestation_type == AttestationType.CPU: + public_key = RSAAlgorithm.from_jwk(key) + else: + return Err("Invalid token type or key information.") + except Exception as e: + return Err(f"Failed to process public key: {str(e)}") + + try: + # Verify the JWT using the public key + payload = jwt.decode( + token, + public_key, + algorithms=[unverified_header["alg"]], + options={"verify_exp": verify_expiration}, + ) + return Ok(payload) + except jwt.ExpiredSignatureError: + return Err("JWT token has expired.") + except jwt.InvalidTokenError as e: + return Err(f"JWT token signature is invalid: {str(e)}") diff --git a/packages/syft/src/syft/service/blob_storage/service.py b/packages/syft/src/syft/service/blob_storage/service.py index 3254e2918da..d3f28f121b2 100644 --- a/packages/syft/src/syft/service/blob_storage/service.py +++ b/packages/syft/src/syft/service/blob_storage/service.py @@ -166,7 +166,9 @@ def get_files_from_bucket( return blob_files - @service_method(path="blob_storage.get_by_uid", name="get_by_uid") + @service_method( + path="blob_storage.get_by_uid", name="get_by_uid", roles=GUEST_ROLE_LEVEL + ) def get_blob_storage_entry_by_uid( self, context: AuthedServiceContext, uid: UID ) -> BlobStorageEntry | SyftError: diff --git a/packages/syft/src/syft/service/code/user_code.py b/packages/syft/src/syft/service/code/user_code.py index 4b8c1c8e7ae..a86dcfb26ee 100644 --- a/packages/syft/src/syft/service/code/user_code.py +++ b/packages/syft/src/syft/service/code/user_code.py @@ -31,6 +31,7 @@ from IPython.display import display from pydantic import ValidationError from pydantic import field_validator +from pydantic import model_validator from result import Err from result import Ok from result import Result @@ -54,11 +55,14 @@ from ...types.dicttuple import DictTuple from ...types.syft_object import PartialSyftObject from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from ...types.syft_object import SyftObject from ...types.syncable_object import SyncableSyftObject from ...types.transforms import TransformContext from ...types.transforms import add_server_uid_for_key from ...types.transforms import generate_id +from ...types.transforms import keep +from ...types.transforms import rename from ...types.transforms import transform from ...types.uid import UID from ...util import options @@ -80,10 +84,12 @@ from ..policy.policy import Constant from ..policy.policy import CustomInputPolicy from ..policy.policy import CustomOutputPolicy +from ..policy.policy import EmptyRuntimePolicy from ..policy.policy import EmpyInputPolicy from ..policy.policy import ExactMatch from ..policy.policy import InputPolicy from ..policy.policy import OutputPolicy +from ..policy.policy import RuntimePolicy from ..policy.policy import SingleExecutionExactOutput from ..policy.policy import SubmitUserPolicy from ..policy.policy import UserPolicy @@ -273,7 +279,7 @@ def get_sync_dependencies(self, context: AuthedServiceContext) -> list[UID]: @serializable() -class UserCode(SyncableSyftObject): +class UserCodeV1(SyncableSyftObject): # version __canonical_name__ = "UserCode" __version__ = SYFT_OBJECT_VERSION_1 @@ -306,6 +312,47 @@ class UserCode(SyncableSyftObject): l0_deny_reason: str | None = None _has_output_read_permissions_cache: bool | None = None + +@serializable() +class UserCode(SyncableSyftObject): + # version + __canonical_name__ = "UserCode" + __version__ = SYFT_OBJECT_VERSION_2 + + id: UID + server_uid: UID | None = None + user_verify_key: SyftVerifyKey + raw_code: str + input_policy_type: type[InputPolicy] | UserPolicy + input_policy_init_kwargs: dict[Any, Any] | None = None + input_policy_state: bytes = b"" + output_policy_type: type[OutputPolicy] | UserPolicy + output_policy_init_kwargs: dict[Any, Any] | None = None + output_policy_state: bytes = b"" + runtime_policy_type: type[RuntimePolicy] | UserPolicy + runtime_policy_init_kwargs: dict[Any, Any] | None = None + runtime_policy_state: bytes = b"" + parsed_code: str + service_func_name: str + unique_func_name: str + user_unique_func_name: str + code_hash: str + raw_code_hash: str + signature: inspect.Signature + status_link: LinkedObject | None = None + input_kwargs: list[str] + submit_time: DateTime | None = None + # tracks if the code calls datasite.something, variable is set during parsing + uses_datasite: bool = False + + nested_codes: dict[str, tuple[LinkedObject, dict]] | None = {} + worker_pool_name: str | None = None + origin_server_side_type: ServerSideType + l0_deny_reason: str | None = None + _has_output_read_permissions_cache: bool | None = None + project_id: UID | None = None + input_id2hash: dict[UID, str] | None = None + __table_coll_widths__ = [ "min-content", "auto", @@ -341,6 +388,9 @@ class UserCode(SyncableSyftObject): "output_policy_type", "output_policy_init_kwargs", "output_policy_state", + "runtime_policy_type", + "runtime_policy_init_kwargs", + "runtime_policy_state", ] @field_validator("service_func_name", mode="after") @@ -456,6 +506,9 @@ def _compute_status_l0( def status(self) -> UserCodeStatusCollection | SyftError: # Clientside only + if self.project_id is not None: + return self.get_code_status() + if self.is_l0_deployment: if self.status_link is not None: return SyftError( @@ -529,6 +582,33 @@ def code_status(self) -> list: ) return status_list + def get_code_status(self) -> list: + if self.project_id is None: + return self.code_status + + api = APIRegistry.api_for( + server_uid=self.syft_server_location, + user_verify_key=self.syft_client_verify_key, + ) + if api is None: + return SyftError( + message=f"Can't access Syft API. You must login to {self.syft_server_location}" + ) + project = api.services.project.get_by_uid(self.project_id) + project_codes = [pc for pc in project.code if pc.id == self.id] + if not project_codes: + raise Exception(f"UserCode {self.id} not found in project {project.id}") + status_dict = project_codes[0].status(project, verbose_return=True) + final_status = status_dict.pop("final_status") + + status_list = [] + for server_identity, status in status_dict.items(): + status_list.append( + f"Server: {server_identity.server_name}, Status: {status.value}", + ) + status_list.append(f"Final Status: {final_status.value}") + return status_list + @property def input_policy(self) -> InputPolicy | None: if self.status.approved or self.input_policy_type.has_safe_serde: @@ -884,7 +964,7 @@ def _inner_repr(self, level: int = 0) -> str: id: UID = {self.id} service_func_name: str = {self.service_func_name} shareholders: list = {self.input_owners} - status: list = {self.code_status} + status: list = {self.get_code_status()} {constants_str} {shared_with_line} inputs: dict = {inputs_str} @@ -942,7 +1022,7 @@ def _ipython_display_(self, level: int = 0) -> None:

{tabs}id: UID = {self.id}

{tabs}service_func_name: str = {self.service_func_name}

{tabs}shareholders: list = {self.input_owners}

-

{tabs}status: list = {self.code_status}

+

{tabs}status: list = {self.get_code_status()}

{tabs}{constants_str} {tabs}{shared_with_line}

{tabs}inputs: dict = 

{self._inputs_json}

@@ -1007,7 +1087,7 @@ class UserCodeUpdate(PartialSyftObject): @serializable(without=["local_function"]) -class SubmitUserCode(SyftObject): +class SubmitUserCodeV1(SyftObject): # version __canonical_name__ = "SubmitUserCode" __version__ = SYFT_OBJECT_VERSION_1 @@ -1024,6 +1104,29 @@ class SubmitUserCode(SyftObject): input_kwargs: list[str] worker_pool_name: str | None = None + +@serializable(without=["local_function"]) +class SubmitUserCode(SyftObject): + # version + __canonical_name__ = "SubmitUserCode" + __version__ = SYFT_OBJECT_VERSION_2 + + id: UID | None = None # type: ignore[assignment] + code: str + func_name: str + signature: inspect.Signature + input_policy_type: SubmitUserPolicy | UID | type[InputPolicy] + input_policy_init_kwargs: dict[Any, Any] | None = {} + output_policy_type: SubmitUserPolicy | UID | type[OutputPolicy] + output_policy_init_kwargs: dict[Any, Any] | None = {} + runtime_policy_type: SubmitUserPolicy | UID | type[RuntimePolicy] + runtime_policy_init_kwargs: dict[Any, Any] | None = {} + local_function: Callable | None = None + input_kwargs: list[str] + worker_pool_name: str | None = None + project_id: UID | None = None + input_id2hash: dict[UID, str] | None = None + __repr_attrs__ = ["func_name", "code"] @field_validator("func_name", mode="after") @@ -1041,10 +1144,31 @@ def add_output_policy_ids(cls, values: Any) -> Any: values["id"] = UID() return values + @model_validator(mode="before") + @classmethod + def initialize_input_hash(cls, values: dict) -> dict: + if "input_policy_init_kwargs" in values and "input_id2hash" not in values: + input_id2hash = {} + for server_identity, obj_dict in values["input_policy_init_kwargs"].items(): + api = APIRegistry.get_by_recent_server_uid( + server_uid=server_identity.server_id, + ) + if api is None: + return SyftError( + f"Can't access the api. You must login to {server_identity.server_id}" + ) + for obj_id in obj_dict.values(): + input_id2hash[obj_id] = api.services.action.get_hash(obj_id) + values["input_id2hash"] = input_id2hash + return values + @property def kwargs(self) -> dict[Any, Any] | None: return self.input_policy_init_kwargs + def get_code_hash(self) -> str: + return get_raw_code_hash(self.code) + def __call__( self, *args: Any, @@ -1188,12 +1312,22 @@ def input_owner_verify_keys(self) -> list[str] | None: return [x.verify_key for x in self.input_policy_init_kwargs.keys()] return None + @property + def input_owner_server_uids(self) -> list[UID] | None: + if self.input_policy_init_kwargs is not None: + return [x.server_id for x in self.input_policy_init_kwargs.keys()] + return None + def get_code_hash(code: str, user_verify_key: SyftVerifyKey) -> str: full_str = f"{code}{user_verify_key}" return hashlib.sha256(full_str.encode()).hexdigest() +def get_raw_code_hash(code: str) -> str: + return hashlib.sha256(code.encode()).hexdigest() + + def is_valid_usercode_name(func_name: str) -> Result[Any, str]: if len(func_name) == 0: return Err("Function name cannot be empty") @@ -1255,10 +1389,12 @@ def replace_func_name(src: str, new_func_name: str) -> str: def syft_function( input_policy: InputPolicy | UID | None = None, output_policy: OutputPolicy | UID | None = None, + runtime_policy: RuntimePolicy | UID | None = None, share_results_with_owners: bool = False, worker_pool_name: str | None = None, name: str | None = None, ) -> Callable: + # Input policy if input_policy is None: input_policy = EmpyInputPolicy() @@ -1270,6 +1406,7 @@ def syft_function( input_policy_type = type(input_policy) init_input_kwargs = getattr(input_policy, "init_kwargs", {}) + # Output policy if output_policy is None: output_policy = SingleExecutionExactOutput() @@ -1278,6 +1415,11 @@ def syft_function( else: output_policy_type = type(output_policy) + # Runtime policy + if runtime_policy is None: + runtime_policy = EmptyRuntimePolicy() + runtime_policy_type = type(runtime_policy) + def decorator(f: Any) -> SubmitUserCode | SyftError: try: code = dedent(inspect.getsource(f)) @@ -1305,6 +1447,8 @@ def decorator(f: Any) -> SubmitUserCode | SyftError: input_policy_init_kwargs=init_input_kwargs, output_policy_type=output_policy_type, output_policy_init_kwargs=getattr(output_policy, "init_kwargs", {}), + runtime_policy_type=runtime_policy_type, + runtime_policy_init_kwargs=getattr(runtime_policy, "init_kwargs", {}), local_function=f, input_kwargs=input_kwargs, worker_pool_name=worker_pool_name, @@ -1503,6 +1647,7 @@ def hash_code(context: TransformContext) -> TransformContext: context.output["raw_code"] = code code_hash = get_code_hash(code, context.credentials) context.output["code_hash"] = code_hash + context.output["raw_code_hash"] = get_raw_code_hash(code) return context @@ -1547,6 +1692,14 @@ def check_output_policy(context: TransformContext) -> TransformContext: return context +def check_runtime_policy(context: TransformContext) -> TransformContext: + if context.output is not None: + policy = context.output["runtime_policy_type"] + policy = check_policy(policy=policy, context=context) + context.output["runtime_policy_type"] = policy + return context + + def create_code_status(context: TransformContext) -> TransformContext: # relative from .user_code_service import UserCodeService @@ -1638,6 +1791,7 @@ def submit_user_code_to_user_code() -> list[Callable]: generate_unique_func_name, check_input_policy, check_output_policy, + check_runtime_policy, new_check_code, locate_launch_jobs, add_credentials_for_key("user_verify_key"), @@ -1649,6 +1803,33 @@ def submit_user_code_to_user_code() -> list[Callable]: ] +# TODO: remove this and make the code submittable directly from the +# project +@transform(UserCode, SubmitUserCode) +def user_code_to_submit_user_code() -> list[Callable]: + return [ + rename("raw_code", "code"), + rename("service_func_name", "func_name"), + keep( + [ + "id", + "code", + "func_name", + "signature", + "input_policy_type", + "input_policy_init_kwargs", + "output_policy_type", + "output_policy_init_kwargs", + "runtime_policy_type", + "runtime_policy_init_kwargs", + "input_kwargs", + "worker_pool_name", + "input_id2hash", + ] + ), + ] + + @serializable() class UserCodeExecutionResult(SyftObject): # version diff --git a/packages/syft/src/syft/service/code/user_code_service.py b/packages/syft/src/syft/service/code/user_code_service.py index 4d200bdbf22..808493b4e13 100644 --- a/packages/syft/src/syft/service/code/user_code_service.py +++ b/packages/syft/src/syft/service/code/user_code_service.py @@ -731,6 +731,7 @@ def map_kwargs_to_id(kwargs: dict[str, Any]) -> dict[str, Any]: from ...types.twin_object import TwinObject from ..action.action_object import ActionObject from ..dataset.dataset import Asset + from ..model.model import Model filtered_kwargs = {} for k, v in kwargs.items(): @@ -741,6 +742,8 @@ def map_kwargs_to_id(kwargs: dict[str, Any]) -> dict[str, Any]: value = v.id if isinstance(v, Asset): value = v.action_id + if isinstance(v, Model): + value = v.id if not isinstance(value, UID): raise Exception(f"Input {k} must have a UID not {type(v)}") diff --git a/packages/syft/src/syft/service/dataset/dataset.py b/packages/syft/src/syft/service/dataset/dataset.py index 10b5be04ca9..84760697712 100644 --- a/packages/syft/src/syft/service/dataset/dataset.py +++ b/packages/syft/src/syft/service/dataset/dataset.py @@ -27,6 +27,7 @@ from ...types.dicttuple import DictTuple from ...types.syft_object import PartialSyftObject from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from ...types.syft_object import SyftObject from ...types.transforms import TransformContext from ...types.transforms import generate_id @@ -95,7 +96,7 @@ def __hash__(self) -> int: @serializable() -class Asset(SyftObject): +class AssetV1(SyftObject): # version __canonical_name__ = "Asset" __version__ = SYFT_OBJECT_VERSION_1 @@ -116,6 +117,30 @@ class Asset(SyftObject): _dataset_name: str | None = None __syft_include_id_coll_repr__ = False + +@serializable() +class Asset(SyftObject): + # version + __canonical_name__ = "Asset" + __version__ = SYFT_OBJECT_VERSION_2 + + action_id: UID + server_uid: UID + name: str + description: MarkdownDescription | None = None + contributors: set[Contributor] = set() + data_subjects: list[DataSubject] = [] + mock_is_real: bool = False + shape: tuple | None = None + created_at: DateTime = DateTime.now() + uploader: Contributor | None = None + asset_hash: str + + # _kwarg_name and _dataset_name are set by the UserCode.assets + _kwarg_name: str | None = None + _dataset_name: str | None = None + __syft_include_id_coll_repr__ = False + def __init__( self, description: MarkdownDescription | str | None = "", @@ -179,6 +204,7 @@ def _repr_html_(self) -> Any:

{self.description}

Asset ID: {self.id}

Action Object ID: {self.action_id}

+

Asset Hash (Private): {self.asset_hash}

{uploaded_by_line}

Created on: {self.created_at}

Data:

@@ -836,6 +862,31 @@ def add_default_server_uid(context: TransformContext) -> TransformContext: return context +def add_asset_hash(context: TransformContext) -> TransformContext: + # relative + from ..action.action_service import ActionService + + if context.output is None: + return context + if context.server is None: + raise ValueError("Context should have a server attached to it.") + + action_id = context.output["action_id"] + if action_id is not None: + action_service = context.server.get_service(ActionService) + # Q: Why is service returning an result object [Ok, Err]? + action_obj = action_service.get(context=context, uid=action_id) + + if action_obj.is_err(): + return SyftError(f"Failed to get action object with id {action_obj.err()}") + # NOTE: for a TwinObject, this hash of the private data + context.output["asset_hash"] = action_obj.ok().hash() + else: + raise ValueError("Asset must have an action_id to generate a hash") + + return context + + @transform(CreateAsset, Asset) def createasset_to_asset() -> list[Callable]: return [ @@ -845,6 +896,7 @@ def createasset_to_asset() -> list[Callable]: create_and_store_twin, set_data_subjects, add_default_server_uid, + add_asset_hash, ] diff --git a/packages/syft/src/syft/service/enclave/datasite_enclave_service.py b/packages/syft/src/syft/service/enclave/datasite_enclave_service.py new file mode 100644 index 00000000000..61ae15cd935 --- /dev/null +++ b/packages/syft/src/syft/service/enclave/datasite_enclave_service.py @@ -0,0 +1,394 @@ +# stdlib +import itertools +from typing import Any +from typing import cast + +# relative +from ...serde.serializable import serializable +from ...store.document_store import DocumentStore +from ...types.server_url import ServerURL +from ...types.uid import UID +from ..action.action_object import ActionObject +from ..action.action_permissions import ActionObjectPermission +from ..action.action_permissions import ActionPermission +from ..code.user_code import UserCode +from ..context import AuthedServiceContext +from ..dataset.dataset_service import DatasetService +from ..model.model import ModelRef +from ..model.model_service import ModelService +from ..network.routes import HTTPServerRoute +from ..project.project import Project +from ..project.project_service import ProjectService +from ..response import SyftError +from ..response import SyftSuccess +from ..service import AbstractService +from ..service import service_method +from ..user.user_roles import ADMIN_ROLE_LEVEL +from ..user.user_roles import DATA_SCIENTIST_ROLE_LEVEL +from .enclave import EnclaveInstance +from .enclave_stash import EnclaveInstanceStash + + +@serializable(canonical_name="DatasiteEnclaveService", version=1) +class DatasiteEnclaveService(AbstractService): + """Contains service methods for Datasite -> Enclave communication.""" + + store: DocumentStore + stash: EnclaveInstanceStash + + def __init__(self, store: DocumentStore) -> None: + self.store = store + self.stash = EnclaveInstanceStash(store=store) + + @service_method( + path="enclave.add", + name="add", + roles=ADMIN_ROLE_LEVEL, + ) + def add( + self, + context: AuthedServiceContext, + route: HTTPServerRoute | None = None, + url: str | None = None, + ) -> SyftSuccess | SyftError: + """Add an Enclave to the network.""" + if route is None and url is None: + return SyftError(message="Either route or url must be provided.") + if url: + parsed_url = ServerURL.from_url(url) + route = HTTPServerRoute( + host_or_ip=parsed_url.host_or_ip, + port=parsed_url.port, + protocol=parsed_url.protocol, + ) + + enclave = EnclaveInstance(route=route) + result = self.stash.set( + credentials=context.credentials, + obj=enclave, + add_permissions=[ + ActionObjectPermission( + uid=enclave.id, permission=ActionPermission.ALL_READ + ) + ], + ) + if result.is_err(): + return SyftError(message=str(result.err())) + return SyftSuccess( + message=f"Enclave '{enclave.name}' added to '{context.server.name}' on '{route}'." + ) + + @service_method( + path="enclave.get_all", + name="get_all", + roles=DATA_SCIENTIST_ROLE_LEVEL, + ) + def get_all( + self, context: AuthedServiceContext + ) -> list[EnclaveInstance] | SyftError: + """Add an Enclave to the network.""" + result = self.stash.get_all(context.credentials) + if result.is_ok(): + enclaves = result.ok() + return enclaves + return SyftError(message=result.err()) + + @service_method( + path="enclave.request_enclave", + name="request_enclave", + roles=DATA_SCIENTIST_ROLE_LEVEL, + ) + def request_enclave( + self, context: AuthedServiceContext, user_code_id: UID + ) -> SyftSuccess | SyftError: + """Request an Enclave for running a project.""" + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + code_service = context.server.get_service("usercodeservice") + code: UserCode = code_service.get_by_uid(context=context, uid=user_code_id) + status = code.get_status(context) + if not status.approved: + return SyftError( + message=f"Status for code '{code.service_func_name}' is not Approved." + ) + if not code.runtime_policy_init_kwargs: + return SyftError( + message=f"Code '{code.service_func_name}' does not have a deployment policy." + ) + provider = code.runtime_policy_init_kwargs.get("provider") + if not isinstance(provider, EnclaveInstance): + return SyftError( + message=f"Code '{code.service_func_name}' does not have an Enclave deployment provider." + ) + if context.server.id != provider.syft_server_location: + return SyftError( + message=f"The enclave '{provider.name}' does not belong to" + + f"the current datasite '{context.server.name}'." + ) + + current_server_credentials = context.server.signing_key + enclave_client = provider.get_client(credentials=current_server_credentials) + + result = enclave_client.api.services.enclave.setup_enclave(code=code) + return result + + @service_method( + path="enclave.request_assets_upload", + name="request_assets_upload", + roles=DATA_SCIENTIST_ROLE_LEVEL, + ) + def request_assets_upload( + self, + context: AuthedServiceContext, + user_code_id: UID, + mock_report: bool = False, + ) -> SyftSuccess | SyftError: + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + root_context = context.as_root_context() + + # Get the code + code_service = context.server.get_service("usercodeservice") + code: UserCode = code_service.get_by_uid(context=context, uid=user_code_id) + project_id = code.project_id + if not project_id: + return SyftError( + message=f"[request_assets_upload] Code '{code.service_func_name}' does not belong to a project." + ) + project: Project = context.server.get_service(ProjectService).get_by_uid( + context=root_context, uid=project_id + ) + if isinstance(project, SyftError): + return project + + status = code.get_status(context) + if not status.approved: + return SyftError( + message=f"Code '{code.service_func_name}' is not approved." + ) + + if code.input_policy_init_kwargs is None: + return SyftSuccess(message="No assets to transfer") + + # Get all asset action ids for the current server + asset_action_ids_nested = [ + assets.values() + for server_identity, assets in code.input_policy_init_kwargs.items() + if server_identity.server_id == context.server.id + ] + asset_action_ids = tuple(itertools.chain.from_iterable(asset_action_ids_nested)) + action_objects: list[ActionObject] = [ + context.server.get_service("actionservice") + .get(context=root_context, uid=action_id) + .ok() + for action_id in asset_action_ids + ] + + # Get the enclave client + if not code.runtime_policy_init_kwargs: + return SyftError( + message=f"Code '{code.service_func_name}' does not have a deployment policy." + ) + provider = code.runtime_policy_init_kwargs.get("provider") + if not isinstance(provider, EnclaveInstance): + return SyftError( + message=f"Code '{code.service_func_name}' does not have an Enclave deployment provider." + ) + + current_server_credentials = context.server.signing_key + enclave_client = provider.get_client(credentials=current_server_credentials) + + # Attesation Checks + # Fetch Attestation Report From Enclave for CPU + cpu_report = enclave_client.api.services.attestation.get_cpu_attestation( + raw_token=True, mock_report=mock_report + ) + if not isinstance(cpu_report, (str, SyftError)): + return SyftError( + message="CPU Enclave Attestation Report should be a string or SyftError" + ) + + # Fetch Attestation Report From Enclave for GPU + gpu_report = enclave_client.api.services.attestation.get_gpu_attestation( + raw_token=True, mock_report=mock_report + ) + if not isinstance(gpu_report, (str, SyftError)): + return SyftError( + message="GPU Enclave Attestation Report should be a string or SyftError" + ) + + if isinstance(cpu_report, SyftError): + return SyftError( + message=f"CPU Attestation Report Error: {cpu_report.message}" + ) + + if isinstance(gpu_report, SyftError): + return SyftError( + message=f"GPU Attestation Report Error: {gpu_report.message}" + ) + + project_enclave_report_res = project.add_enclave_attestation_report( + cpu_report=cpu_report, + gpu_report=gpu_report, + enclave_url=enclave_client.connection.url, + ) + + if isinstance(project_enclave_report_res, SyftError): + return project_enclave_report_res + + # Actual data from blob storage is lazy-loaded when the `syft_action_data` property is used for the + # first time. Let's load it now so that it can get properly transferred along with the action objects. + for action_object in action_objects: + # If it is ModelRef, then load all the references + # and wrap them to the Model Ref object + if isinstance(action_object, ModelRef): + model_ref_res = action_object.load_data( + context=context, + wrap_ref_to_obj=True, + unwrap_action_data=False, + remote_client=enclave_client, + ) + if isinstance(model_ref_res, SyftError): + return model_ref_res + # TODO: Optimize this, currently, we load the full action object from blob + # and then send the data to enclave. + _ = action_object.syft_action_data + action_object.syft_blob_storage_entry_id = None + blob_res = action_object._save_to_blob_storage(client=enclave_client) + + action_object.syft_blob_storage_entry_id = cast( + UID | None, action_object.syft_blob_storage_entry_id + ) + # For smaller data, we do not store in blob storage + # so for the cases, where we store in blob storage + # we need to clear the cache , to avoid sending the data again + if action_object.syft_blob_storage_entry_id: + action_object._clear_cache() + if isinstance(blob_res, SyftError): + return blob_res + + # set the object location to the enclave + # TODO: fix Tech Debt + # Currently, Setting the Location of the object to the remote client + # As this is later used by the enclave to fetch the syft_action_data + # in reload_cache method of action object + # This is a quick fix to address the same + action_object._set_obj_location_( + enclave_client.id, current_server_credentials.verify_key + ) + + asset_name = self.get_asset_name( + context=context, action_id=action_object.id + ) + if isinstance(asset_name, SyftError): + return asset_name + + # TODO: Fetch asset name + # Do we want the name in the function + # or do we want to fetch the name from the DB. + project_asset_res = project.add_asset_transfer( + asset_id=action_object.id, + asset_hash=action_object.hash(context=context), + asset_name=asset_name, + code_id=code.id, + ) + if isinstance(project_asset_res, SyftError): + return project_asset_res + + # Upload the assets to the enclave + result = enclave_client.api.services.enclave.upload_assets( + user_code_id=user_code_id, action_objects=action_objects + ) + if isinstance(result, SyftError): + return result + + return SyftSuccess( + message=f"Assets transferred from Datasite '{context.server.name}' to Enclave '{enclave_client.name}'" + ) + + def get_asset_name( + self, context: AuthedServiceContext, action_id: UID + ) -> SyftError | str: + asset_name = None + # Find if the action_id is part of a dataset + dataset_service = context.server.get_service(DatasetService) + datasets = dataset_service.get_all(context=context) + for dataset in datasets: + for asset in dataset.asset_list: + if asset.action_id == action_id: + asset_name = asset.name + break + if asset_name: + break + + if asset_name: + return asset_name + + # Find if the action_id is part of a model + model_service = context.server.get_service(ModelService) + model = model_service.get_by_uid(context=context, uid=action_id) + if isinstance(model, SyftError): + return model + if model.id == action_id: + return model.name + + return SyftError(message=f"Asset name not found for action_id: {action_id}") + + @service_method( + path="enclave.request_code_execution", + name="request_code_execution", + roles=DATA_SCIENTIST_ROLE_LEVEL, + ) + def request_code_execution( + self, context: AuthedServiceContext, user_code_id: UID + ) -> Any: + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + root_context = context.as_root_context() + code_service = context.server.get_service("usercodeservice") + code: UserCode = code_service.get_by_uid(context=context, uid=user_code_id) + project_id = code.project_id + if not project_id: + return SyftError( + message=f"[request_code_execution] Code '{code.service_func_name}' does not belong to a project." + ) + project: Project = context.server.get_service(ProjectService).get_by_uid( + context=root_context, uid=project_id + ) + if isinstance(project, SyftError): + return project + + project_execution_res = project.add_execution_start(code_id=code.id) + if isinstance(project_execution_res, SyftError): + return project_execution_res + + status = code.get_status(context) + if not status.approved: + return SyftError( + message=f"Code '{code.service_func_name}' is not approved." + ) + + if not code.runtime_policy_init_kwargs: + return SyftError( + message=f"Code '{code.service_func_name}' does not have a deployment policy." + ) + provider = code.runtime_policy_init_kwargs.get("provider") + if not isinstance(provider, EnclaveInstance): + return SyftError( + message=f"Code '{code.service_func_name}' does not have an Enclave deployment provider." + ) + + current_server_credentials = context.server.signing_key + enclave_client = provider.get_client(credentials=current_server_credentials) + + result = enclave_client.api.services.enclave.execute_code( + user_code_id=user_code_id + ) + + project_output_res = project.add_enclave_output(code_id=code.id, output=result) + if isinstance(project_output_res, SyftError): + return project_output_res + return result diff --git a/packages/syft/src/syft/service/enclave/enclave.py b/packages/syft/src/syft/service/enclave/enclave.py new file mode 100644 index 00000000000..558c8f37333 --- /dev/null +++ b/packages/syft/src/syft/service/enclave/enclave.py @@ -0,0 +1,122 @@ +# stdlib +from enum import Enum +from typing import Any + +# third party +from pydantic import model_validator + +# relative +from ...client.client import SyftClient +from ...client.enclave_client import EnclaveClient +from ...serde.serializable import serializable +from ...server.credentials import SyftSigningKey +from ...service.metadata.server_metadata import ServerMetadataJSON +from ...service.network.routes import ServerRouteType +from ...service.network.server_peer import route_to_connection +from ...service.response import SyftException +from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SyftObject +from ...types.uid import UID +from ...util.markdown import as_markdown_python_code +from ...util.util import get_qualname_for + + +@serializable(canonical_name="EnclaveStatus", version=1) +class EnclaveStatus(Enum): + IDLE = "idle" + NOT_INITIALIZED = "not_initialized" + INITIALIZING = "initializing" + BUSY = "busy" + SHUTTING_DOWN = "shutting_down" + + +@serializable() +class EnclaveInstance(SyftObject): + # version + __canonical_name__ = "EnclaveInstance" + __version__ = SYFT_OBJECT_VERSION_1 + + server_uid: UID + name: str + route: ServerRouteType + status: EnclaveStatus = EnclaveStatus.NOT_INITIALIZED + metadata: ServerMetadataJSON | None = None + + __attr_searchable__ = ["name", "route", "status"] + __repr_attrs__ = ["name", "route", "status"] + __attr_unique__ = ["name"] + + @model_validator(mode="before") + @classmethod + def initialize_values(cls, values: dict[str, Any]) -> dict[str, Any]: + is_being_created = "id" not in values + if is_being_created and "route" in values: + connection = route_to_connection(values["route"]) + metadata = connection.get_server_metadata(credentials=None) + if not metadata: + raise SyftException("Failed to fetch metadata from the server") + + values.update( + { + "server_uid": UID(metadata.id), + "name": metadata.name, + "status": cls.get_status(), + "metadata": metadata, + } + ) + return values + + @classmethod + def get_status(cls) -> EnclaveStatus: + # TODO check the actual status of the enclave + return EnclaveStatus.IDLE + + def get_client(self, credentials: SyftSigningKey) -> SyftClient: + connection = route_to_connection(route=self.route) + client = EnclaveClient(connection=connection, credentials=credentials) + return client + + def get_guest_client(self) -> SyftClient: + connection = route_to_connection(route=self.route) + client = EnclaveClient( + connection=connection, credentials=SyftSigningKey.generate() + ) + return client + + def __hash__(self) -> int: + return hash(self.name) + + def __eq__(self, other: Any) -> bool: + return hash(self) == hash(other) + + def __repr_syft_nested__(self) -> str: + return f"Enclave({self.name})" + + def __repr__(self) -> str: + return f"" + + def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: + s_indent = " " * indent * 2 + class_name = get_qualname_for(type(self)) + _repr_dict = { + "id": self.metadata.id if self.metadata else "", + "name": self.name, + "route": self.route, + "status": str(self.status), + "verify_key": self.metadata.verify_key if self.metadata else "", + "syft_version": self.metadata.syft_version if self.metadata else "", + "server_type": self.metadata.server_type if self.metadata else "", + "organization": self.metadata.organization if self.metadata else "", + "admin_email": self.metadata.admin_email if self.metadata else "", + "server_side_type": self.metadata.server_side_type if self.metadata else "", + } + + blank_string = '""' + _repr_str = f"{s_indent}class {class_name}:\n" + "".join( + [ + f"{s_indent} {key} = {value or blank_string}\n" + for key, value in _repr_dict.items() + ] + ) + + return as_markdown_python_code(_repr_str) if wrap_as_python else _repr_str diff --git a/packages/syft/src/syft/service/enclave/enclave_output.py b/packages/syft/src/syft/service/enclave/enclave_output.py new file mode 100644 index 00000000000..9d907c5b525 --- /dev/null +++ b/packages/syft/src/syft/service/enclave/enclave_output.py @@ -0,0 +1,92 @@ +# stdlib +from typing import Any + +# relative +from ...serde.serializable import serializable +from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SyftObject +from ...util.markdown import as_markdown_python_code +from ...util.util import get_qualname_for +from ..code.user_code import UserCode + + +@serializable() +class VerifiableOutput(SyftObject): + __canonical_name__ = "VerifiableOutput" + __version__ = SYFT_OBJECT_VERSION_1 + + code: UserCode + enclave_output: Any + + __repr_attrs__ = ["inputs", "code"] + + @property + def inputs(self) -> list[dict[str, str]]: + inputs = [] + code_init_kwargs = ( + self.code.input_policy_init_kwargs + if self.code.input_policy_init_kwargs is not None + else [] + ) + + code_kwargs_uid_to_hash = self.code.input_id2hash + for server_identity, asset_id_map in code_init_kwargs.items(): + for asset_name, asset_id in asset_id_map.items(): + inputs.append( + { + "id": str(asset_id), + "name": asset_name, + "hash": code_kwargs_uid_to_hash[asset_id], + "datasite": server_identity.server_name, + } + ) + return inputs + + @property + def output(self) -> Any: + return self.enclave_output + + # output_hash: str + # enclave_key: str + # enclave_signature: str + + # def _html_repr_() -> str: + # # pretty print the table of result and hashesh + # # call result.output for real output + + def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: + s_indent = " " * indent * 2 + class_name = get_qualname_for(type(self)) + _repr_str = f"{s_indent}class {class_name}:\n" + _repr_str += f"{s_indent} id: UID = {self.id}\n" + _repr_str += f"{s_indent} inputs:\n" + _repr_str += ( + "\n".join( + [ + f'{s_indent} - id: UID = {i["id"]}\n' + f'{s_indent} datasite: str = "{i["datasite"]}"\n' + f'{s_indent} name: str = "{i["name"]}"\n' + f'{s_indent} hash: str = "{i["hash"]}"\n' + for i in self.inputs + ] + ) + + "\n" + ) + _repr_str += f"{s_indent} code: UserCode\n" + _repr_str += f"{s_indent} id: UID = {self.code.id}\n" + _repr_str += f'{s_indent} func_name: str = "{self.code.service_func_name}"\n' + _repr_str += f'{s_indent} hash: str = "{self.code.raw_code_hash}"\n' + _repr_str += f"{s_indent} raw_code: str\n" + _repr_str += "\n".join( + [ + f"{' '*3}{substring}" + for substring in self.code.raw_code.split("\n")[:-1] + ] + ) + + if wrap_as_python: + return ( + as_markdown_python_code(_repr_str) + + "\n\n**Call `.output` to view the output.**\n" + ) + return _repr_str + "\n\n**Call `.output` to view the output.**\n" diff --git a/packages/syft/src/syft/service/enclave/enclave_service.py b/packages/syft/src/syft/service/enclave/enclave_service.py index 2f88c60e123..40e3be3a49d 100644 --- a/packages/syft/src/syft/service/enclave/enclave_service.py +++ b/packages/syft/src/syft/service/enclave/enclave_service.py @@ -1,14 +1,210 @@ # stdlib +from typing import Any # relative from ...serde.serializable import serializable +from ...service.response import SyftError +from ...service.response import SyftSuccess +from ...service.user.user_roles import GUEST_ROLE_LEVEL from ...store.document_store import DocumentStore +from ...types.twin_object import TwinObject +from ...types.uid import UID +from ..action.action_object import ActionObject +from ..code.user_code import SubmitUserCode +from ..code.user_code import UserCode +from ..code.user_code import UserCodeStatus +from ..context import AuthedServiceContext +from ..model.model import ModelRef from ..service import AbstractService +from ..service import service_method +from .enclave_output import VerifiableOutput @serializable(canonical_name="EnclaveService", version=1) class EnclaveService(AbstractService): + """Contains service methods exposed by Enclaves.""" + store: DocumentStore def __init__(self, store: DocumentStore) -> None: self.store = store + + @service_method( + path="enclave.setup_enclave", + name="setup_enclave", + roles=GUEST_ROLE_LEVEL, # TODO 🟣 Only an enclave's owner datasite server should call this + ) + def setup_enclave( + self, context: AuthedServiceContext, code: UserCode | SubmitUserCode + ) -> SyftSuccess | SyftError: + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + root_context = context.as_root_context() + + # TODO add queuing mechanism + + if isinstance(code, UserCode): + code = code.to(SubmitUserCode) + + result = context.server.get_service("usercodeservice").submit( + root_context, code + ) + if isinstance(result, SyftError): + return result + return SyftSuccess(message="Enclave setup successful") + + @service_method( + path="enclave.upload_assets", + name="upload_assets", + roles=GUEST_ROLE_LEVEL, + ) + def upload_assets( + self, + context: AuthedServiceContext, + user_code_id: UID, + action_objects: list[ActionObject] | list[TwinObject], + ) -> SyftSuccess | SyftError: + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + root_context = context.as_root_context() + + code_service = context.server.get_service("usercodeservice") + action_service = context.server.get_service("actionservice") + + # Get the code + code: UserCode = code_service.get_by_uid(context=root_context, uid=user_code_id) + + init_kwargs = code.input_policy_init_kwargs + if not code or not init_kwargs: + return SyftError(message="No assets to transfer") + + server_identity_map = { + server.verify_key: server for server in init_kwargs.keys() + } + uploading_datasite_identity = server_identity_map.get(context.credentials) + + if not uploading_datasite_identity: + return SyftError( + message="You are not allowed to upload assets for the given code" + ) + + kwargs_for_uploading_datasite = init_kwargs[uploading_datasite_identity] + + input_id2hash = code.input_id2hash + if not input_id2hash: + return SyftError(message="No input_id2hash found in code") + + for action_object in action_objects: + if action_object.id not in kwargs_for_uploading_datasite.values(): + return SyftError( + message=f"You are not allowed to upload the asset with id '{action_object.id}'" + ) + expected_hash = input_id2hash.get(action_object.id) + if not expected_hash: + return SyftError( + message=f"Asset with id '{action_object.id}' not found in code input hash" + ) + curr_hash = action_object.hash(context=context) # type: ignore + if expected_hash != curr_hash: + return SyftError( + message=f"❌Asset with id '{action_object.id}' has a different hash \n" + + f"Expected Hash: {expected_hash} \n" + + f"Current Hash: {curr_hash}" + ) + else: + print( + f"✅Asset with id '{action_object.id}' has the correct hash: {expected_hash}" + ) + + pending_assets_for_uploading_datasite = set( + kwargs_for_uploading_datasite.values() + ) + for action_object in action_objects: + if type(action_object) == ModelRef: + result = action_object.store_ref_objs_to_store( + context=root_context, clear_ref_objs=True + ) + else: + result = action_service.set(root_context, action_object) + if isinstance(result, SyftError): + # TODO 🟣 Rollback previously uploaded assets if any error occurs + return result + pending_assets_for_uploading_datasite.remove(action_object.id) + + # Let's approve the code + if len(pending_assets_for_uploading_datasite) == 0: + approved_status_with_reason = ( + UserCodeStatus.APPROVED, + "All dependent assets uploaded by this datasite server.", + ) + status = code.get_status(root_context) + status.status_dict[uploading_datasite_identity] = ( + approved_status_with_reason + ) + status_link = code.status_link + if not status_link: + return SyftError( + message=f"Code '{code.service_func_name}' does not have a status link." + ) + res = status_link.update_with_context(root_context, status) + if isinstance(res, SyftError): + return res + + return SyftSuccess( + message=f"{len(action_objects)} assets uploaded successfully" + ) + + @service_method( + path="enclave.execute_code", + name="execute_code", + roles=GUEST_ROLE_LEVEL, + ) + def execute_code(self, context: AuthedServiceContext, user_code_id: UID) -> Any: + if not context.server or not context.server.signing_key: + return SyftError(message=f"{type(context)} has no server") + + # TODO only allow execution for datasite servers in output_policy.share_result_with list + root_context = context.as_root_context() + + code_service = context.server.get_service("usercodeservice") + job_service = context.server.get_service("jobservice") + + code: UserCode = code_service.get_by_uid(context=root_context, uid=user_code_id) + + jobs = job_service.get_by_user_code_id( + context=root_context, user_code_id=code.id + ) + if jobs: + job = jobs[-1] + job_res = job.wait().get() + return get_verifiable_result(job_res, code) + + init_kwargs = ( + code.input_policy_init_kwargs.values() + if code.input_policy_init_kwargs is not None + else [] + ) + kwargs = {k: v for d in init_kwargs for k, v in d.items()} + + admin_client = context.server.root_client + job = admin_client.api.services.code.call(blocking=False, uid=code.id, **kwargs) + execution_result = job.wait().get() + result = get_verifiable_result(execution_result, code=code) + # result = get_encrypted_result(context, execution_result) + return result + + +def get_encrypted_result(context: AuthedServiceContext, result: Any) -> Any: + # TODO 🟣 Encrypt the result before sending it back to the user + return result + + +def get_verifiable_result(result: Any, code: UserCode) -> Any: + # TODO: Code hash includes the Verify Key of the User, for now exclude it. + res = VerifiableOutput( + code=code, + enclave_output=result, + ) + return res diff --git a/packages/syft/src/syft/service/enclave/enclave_stash.py b/packages/syft/src/syft/service/enclave/enclave_stash.py new file mode 100644 index 00000000000..c48a059c372 --- /dev/null +++ b/packages/syft/src/syft/service/enclave/enclave_stash.py @@ -0,0 +1,15 @@ +# relative +from ...serde.serializable import serializable +from ...store.document_store import BaseUIDStoreStash +from ...store.document_store import PartitionSettings +from ...util.telemetry import instrument +from .enclave import EnclaveInstance + + +@instrument +@serializable(canonical_name="EnclaveInstanceStash", version=1) +class EnclaveInstanceStash(BaseUIDStoreStash): + object_type = EnclaveInstance + settings: PartitionSettings = PartitionSettings( + name=EnclaveInstance.__canonical_name__, object_type=EnclaveInstance + ) diff --git a/packages/syft/src/syft/service/model/model.py b/packages/syft/src/syft/service/model/model.py new file mode 100644 index 00000000000..daa4699c6fa --- /dev/null +++ b/packages/syft/src/syft/service/model/model.py @@ -0,0 +1,1136 @@ +# stdlib +from collections.abc import Callable +from datetime import datetime +from enum import Enum +import hashlib +import os +import random +from string import Template +from textwrap import dedent +from typing import Any +from typing import ClassVar +from typing import cast + +# third party +from IPython.display import HTML +from IPython.display import Markdown +from IPython.display import display +from pydantic import ConfigDict +from pydantic import model_validator +from result import Err +from result import Ok +from result import OkErr +from result import Result + +# relative +from ...client.api import APIRegistry +from ...client.client import SyftClient +from ...serde.serializable import serializable +from ...serde.serialize import _serialize as serialize +from ...types.datetime import DateTime +from ...types.dicttuple import DictTuple +from ...types.file import SyftFolder +from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SyftObject +from ...types.transforms import TransformContext +from ...types.transforms import generate_id +from ...types.transforms import transform +from ...types.transforms import validate_url +from ...types.uid import UID +from ...util.markdown import as_markdown_python_code +from ...util.notebook_ui.components.sync import CopyIDButton +from ..action.action_object import ActionDataEmpty +from ..action.action_object import ActionObject +from ..action.action_object import BASE_PASSTHROUGH_ATTRS +from ..action.action_service import ActionService +from ..context import AuthedServiceContext +from ..dataset.dataset import Contributor +from ..dataset.dataset import MarkdownDescription +from ..policy.policy import get_code_from_class +from ..response import SyftError +from ..response import SyftSuccess +from ..response import SyftWarning +from .model_html_template import asset_repr_template +from .model_html_template import generate_attr_html +from .model_html_template import model_repr_template + + +def has_permission(data_result: Any) -> bool: + # TODO: implement in a better way + return not ( + isinstance(data_result, str) + and data_result.startswith("Permission") + and data_result.endswith("denied") + ) + + +@serializable() +class ModelPageView(SyftObject): + # version + __canonical_name__ = "ModelPageView" + __version__ = SYFT_OBJECT_VERSION_1 + + models: DictTuple + total: int + + +# TODO: consider unifying to card or description +def _markdownify_variable(values: dict, varname: str) -> Any: + if isinstance(values, dict) and isinstance(varname, str) and varname: + varvalue = values.get(varname) + if varvalue is not None: + values[varname] = MarkdownDescription(text=str(varvalue)) + + return values + + +def _markdownify_description(values: dict) -> Any: + return _markdownify_variable(values, "description") + + +def _markdownify_card(values: dict) -> Any: + return _markdownify_variable(values, "card") + + +@serializable() +class ModelAsset(SyftObject): + # version + __canonical_name__ = "ModelAsset" + __version__ = SYFT_OBJECT_VERSION_1 + + __repr_attrs__ = ["name", "url"] + + name: str + description: MarkdownDescription | None = None + contributors: set[Contributor] = set() + action_id: UID + server_uid: UID + created_at: DateTime = DateTime.now() + asset_hash: str + + _description = model_validator(mode="before")(_markdownify_description) + + __repr_attrs__ = ["name", "created_at", "asset_hash"] + + def _ipython_display_(self) -> None: + if self.description: + string = f"""
+ Show Asset Description: + {self.description._repr_markdown_()} + """ + display(HTML(self._repr_html_()), Markdown(string)) + else: + display(HTML(self._repr_html_())) + + def _repr_html_(self) -> Any: + identifier = random.randint(1, 2**32) # nosec + result_tab_id = f"Result_{identifier}" + logs_tab_id = f"Logs_{identifier}" + model_object_type = "Asset" + api_header = "model_assets/" + model_name = f"{self.name}" + button_html = CopyIDButton(copy_text=str(self.id), max_width=60).to_html() + + attrs = { + "Created at": str(self.created_at), + "Action ID": str(self.action_id), + "Server ID": str(self.server_uid), + "Asset Hash": str(self.asset_hash), + } + attrs_html = generate_attr_html(attrs) + + template = Template(asset_repr_template) + return template.substitute( + model_object_type=model_object_type, + api_header=api_header, + model_name=model_name, + button_html=button_html, + attrs_html=attrs_html, + identifier=identifier, + result_tab_id=result_tab_id, + logs_tab_id=logs_tab_id, + result=None, + ) + + def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: + _repr_str = f"Asset: {self.name}\n" + _repr_str += f"Description: {self.description}\n" + _repr_str += f"Contributors: {len(self.contributors)}\n" + for contributor in self.contributors: + _repr_str += f"\t{contributor.name}: {contributor.email}\n" + return as_markdown_python_code(_repr_str) + + def __eq__(self, other: object) -> bool: + if not isinstance(other, ModelAsset): + return False + return ( + self.name == other.name + and self.contributors == other.contributors + and self.description == other.description + and self.action_id == other.action_id + and self.created_at == other.created_at + ) + + @property + def data(self) -> Any: + # relative + from ...client.api import APIRegistry + + api = APIRegistry.api_for( + server_uid=self.server_uid, + user_verify_key=self.syft_client_verify_key, + ) + if api is None or api.services is None: + return None + res = api.services.action.get(self.action_id) + if has_permission(res): + return res.syft_action_data + else: + warning = SyftWarning( + message="You do not have permission to access private data." + ) + display(warning) + return None + + @property + def mock(self) -> SyftError | Any: + # relative + from ...client.api import APIRegistry + + api = APIRegistry.api_for( + server_uid=self.syft_server_location, + user_verify_key=self.syft_client_verify_key, + ) + if api is None: + raise ValueError(f"api is None. You must login to {self.syft_server_uid}") + result = api.services.action.get_mock(self.action_id) + if isinstance(result, SyftError): + return result + try: + if isinstance(result, SyftObject): + return result.syft_action_data + return result + except Exception as e: + return SyftError(message=f"Failed to get mock. {e}") + + # def __call__(self, *args, **kwargs) -> Any: + # endpoint = self.endpoint + # result = endpoint.__call__(*args, **kwargs) + # return result + + +@serializable() +class SubmitModelCode(ActionObject): + # version + __canonical_name__ = "SubmitModelCode" + __version__ = SYFT_OBJECT_VERSION_1 + + syft_internal_type: ClassVar[type] = str + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + [ + "code", + "class_name", + "__call__", + ] + + class_name: str + + @property + def code(self) -> str: + return self.syft_action_data + + def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: + return as_markdown_python_code(self.code) + + def __call__(self, **kwargs: dict) -> Any: + # Load Class + exec(self.code) + + # execute it + func_string = f"{self.class_name}(**kwargs)" + result = eval(func_string, None, locals()) # nosec + + return result + + __repr_attrs__ = ["class_name", "code"] + + +@serializable(canonical_name="SyftModelClass", version=1) +class SyftModelClass: + def __init__(self, assets: list[ModelAsset]) -> None: + self.__user_init__(assets) + + def __user_init__(self, assets: list[ModelAsset]) -> None: + pass + + def inference(self) -> Any: + pass + + def generate_mock_assets(self, ref_model_path: str | SyftFolder) -> Any: + pass + + +@serializable(canonical_name="HFModelClass", version=1) +class HFModelClass(SyftModelClass): + repo_id: str | None = None + + def __user_init__(self, assets: list) -> None: + model_folder = assets[0] + model_folder = str(model_folder.model_folder) + + from transformers import AutoModelForCausalLM # noqa + from transformers import AutoTokenizer # noqa + + self.model = AutoModelForCausalLM.from_pretrained(model_folder) + self.tokenizer = AutoTokenizer.from_pretrained(model_folder) + self.pad_token_id = ( + self.tokenizer.pad_token_id + if self.tokenizer.pad_token_id + else self.tokenizer.eos_token_id + ) + + def __call__(self, prompt: str, raw=False, **kwargs) -> str: + # Makes the model callable for direct predictions. + input_ids = self.tokenizer(prompt, return_tensors="pt").input_ids + gen_tokens = self.model.generate( + input_ids, + do_sample=True, + temperature=0.9, + max_length=100, + **kwargs, + ) + if raw: + return gen_tokens + else: + gen_text = self.tokenizer.batch_decode(gen_tokens)[0] + return gen_text + + def inference(self, prompt: str, raw=False, **kwargs) -> str: + input_ids = self.tokenizer(prompt, return_tensors="pt").input_ids + gen_tokens = self.model.generate( + input_ids, + do_sample=True, + temperature=0.9, + max_length=100, + pad_token_id=self.pad_token_id, + **kwargs, + ) + if raw: + return gen_tokens + else: + gen_text = self.tokenizer.batch_decode(gen_tokens)[0] + return gen_text + + def inference_dump(self, prompt: str): + encoded_input = self.tokenizer(prompt, return_tensors="pt") + return self.model(**encoded_input) + + @staticmethod + def generate_mock_assets(ref_model_path: str | SyftFolder) -> SyftFolder: + from transformers import AutoModelForCausalLM # noqa + from transformers import AutoTokenizer # noqa + import tempfile # noqa + from pathlib import Path # noqa + # syft + from syft import SyftFolder # noqa + + if isinstance(ref_model_path, SyftFolder): + ref_model_path = ref_model_path.model_folder + + # Load the reference model + ref_model = AutoModelForCausalLM.from_pretrained(ref_model_path) + ref_model_tokenizer = AutoTokenizer.from_pretrained(ref_model_path) + + # Save the reference model to a temporary directory + mock_path = Path(tempfile.gettempdir()) / "mock_weights" + mock_model = AutoModelForCausalLM.from_config(ref_model.config_class()) + mock_model.save_pretrained(mock_path) + ref_model_tokenizer.save_pretrained(mock_path) + + # Create a SyftFolder from the mock model + mock_folder = SyftFolder.from_dir(name="mock", path=mock_path) + return mock_folder + + # Exposes the HF well-known API + def tokenize(self, text): + # Tokenizes a given text. + pass + + def decode(self, token_ids): + # Converts token IDs back to text. + pass + + def train(self): + # Puts the model in training mode. + pass + + def eval(self): + # Puts the model in evaluation mode. + pass + + def forward(self, input_ids, attention_mask, labels=None): + # Defines the forward pass for the model. + pass + + +# @syft_model(name="gpt2") +# class GPT2ModelClass(HFModelClass): +# repo_id = "openai-community/gpt2" + + +def syft_model( + name: str | None = None, +) -> Callable: + def decorator(cls: Any) -> Callable: + try: + code = dedent(get_code_from_class(cls)) + code = f"import syft as sy\n{code}" + class_name = cls.__name__ + res = SubmitModelCode(syft_action_data_cache=code, class_name=class_name) + except Exception as e: + raise e + + success_message = SyftSuccess( + message=f"Syft Model Class '{cls.__name__}' successfully created. " + ) + display(success_message) + return res + + return decorator + + +@serializable() +class CreateModelAsset(SyftObject): + # version + __canonical_name__ = "CreateModelAsset" + __version__ = SYFT_OBJECT_VERSION_1 + + __repr_attrs__ = ["name", "description", "contributors", "data", "created_at"] + + name: str + server_uid: UID | None = None + description: MarkdownDescription | None = None + contributors: set[Contributor] = set() + data: Any | None = None # SyftFolder will go here! + mock: Any | None = None + created_at: DateTime | None = None + action_id: UID | None = None + + model_config = ConfigDict(validate_assignment=True) + + _description = model_validator(mode="before")(_markdownify_description) + + def __init__(self, description: str | None = "", **kwargs: Any) -> None: + if "data" in kwargs: + if isinstance(kwargs["data"], str) and os.path.exists( + os.path.dirname(kwargs["data"]) + ): + model_folder = SyftFolder.from_dir( + name=kwargs["name"] + "_data", path=kwargs["data"] + ) + kwargs["data"] = model_folder + + if "mock" in kwargs: + if isinstance(kwargs["mock"], str) and os.path.exists( + os.path.dirname(kwargs["mock"]) + ): + model_folder = SyftFolder.from_dir( + name=kwargs["name"] + "_mock", path=kwargs["mock"] + ) + kwargs["mock"] = model_folder + + super().__init__( + **kwargs, description=MarkdownDescription(text=str(description)) + ) + + def add_contributor( + self, + name: str, + email: str, + role: Enum | str | None = None, + phone: str | None = None, + note: str | None = None, + ) -> SyftSuccess | SyftError: + try: + _role_str = role.value if isinstance(role, Enum) else role + contributor = Contributor( + name=name, role=_role_str, email=email, phone=phone, note=note + ) + if contributor in self.contributors: + return SyftError( + message=f"Contributor with email: '{email}' already exists in '{self.name}' Asset." + ) + self.contributors.add(contributor) + + return SyftSuccess( + message=f"Contributor '{name}' added to '{self.name}' Asset." + ) + except Exception as e: + return SyftError(message=f"Failed to add contributor. Error: {e}") + + def set_description(self, description: str) -> None: + self.description = MarkdownDescription(text=description) + + def check(self) -> SyftSuccess | SyftError: + return SyftSuccess(message="Model Asset is Valid") + + def contains_empty(self) -> bool: + if isinstance(self.mock, ActionObject) and isinstance( + self.mock.syft_action_data_cache, ActionDataEmpty + ): + return True + if isinstance(self.data, ActionObject) and isinstance( + self.data.syft_action_data_cache, ActionDataEmpty + ): + return True + return False + + def _ipython_display_(self) -> None: + display(HTML(self._repr_html_())) + if self.description: + string = f"""
+ Show Asset Description: + {self.description._repr_markdown_()}""" + display(Markdown(string)) + + def _repr_html_(self) -> Any: + identifier = random.randint(1, 2**32) # nosec + result_tab_id = f"Result_{identifier}" + logs_tab_id = f"Logs_{identifier}" + model_object_type = "Asset" + api_header = "model_assets/" + model_name = f"{self.name}" + button_html = CopyIDButton(copy_text=str(self.id), max_width=60).to_html() + + attrs = { + "Created at": str(self.created_at), + } + attrs_html = generate_attr_html(attrs) + + template = Template(asset_repr_template) + return template.substitute( + model_object_type=model_object_type, + api_header=api_header, + model_name=model_name, + button_html=button_html, + attrs_html=attrs_html, + identifier=identifier, + result_tab_id=result_tab_id, + logs_tab_id=logs_tab_id, + result=None, + ) + + +@serializable() +class Model(SyftObject): + # version + __canonical_name__: str = "Model" + __version__ = SYFT_OBJECT_VERSION_1 + + __attr_searchable__ = ["name", "citation", "url", "card"] + __attr_unique__ = ["name"] + __repr_attrs__ = ["name", "url", "created_at"] + + name: str + asset_list: list[ModelAsset] = [] + server_uid: UID + contributors: set[Contributor] = set() + citation: str | None = None + url: str | None = None + card: MarkdownDescription | None = None + updated_at: str | None = None + created_at: DateTime = DateTime.now() + show_code: bool = False + show_interface: bool = True + example_text: str | None = None + mb_size: float | None = None + code_action_id: UID | None = None + syft_model_hash: str | None = None + + _card = model_validator(mode="before")(_markdownify_card) + + @property + def server_name(self) -> str | SyftError | None: + api = APIRegistry.api_for( + server_uid=self.syft_server_location, + user_verify_key=self.syft_client_verify_key, + ) + if api is None: + # return "SyftError( + # message=f"Can't access Syft API. You must login to {self.syft_server_location}" + # )" + return "unknown" + return api.server_name + + @property + def icon(self) -> str: + return "" + + @property + def model_code(self) -> SubmitModelCode | None: + # relative + from ...client.api import APIRegistry + + api = APIRegistry.api_for( + server_uid=self.syft_server_location, + user_verify_key=self.syft_client_verify_key, + ) + if api is None or api.services is None: + return None + res = api.services.action.get_model_code(self.code_action_id) + if has_permission(res): + return res + else: + warning = SyftWarning( + message="You do not have permission to access private data." + ) + display(warning) + return None + + @property + def mock(self) -> SyftModelClass: + model_code = self.model_code + if model_code is None: + raise ValueError("[Model.mock] Cannot access model code") + mock_assets = [asset.mock for asset in self.asset_list] + return model_code(assets=mock_assets) + + @property + def data(self) -> SyftModelClass: + model_code = self.model_code + if model_code is None: + raise ValueError("[Model.mock] Cannot access model code") + data_assets = [asset.data for asset in self.asset_list] + return model_code(assets=data_assets) + + def _coll_repr_(self) -> dict[str, Any]: + return { + "Name": self.name, + "Assets": len(self.asset_list), + "Url": self.url, + "Size": f"{self.mb_size:.2f} (MB)" if self.mb_size else "Unknown", + "created at": str(self.created_at), + } + + def _ipython_display_(self) -> None: + show_string = "For more information, `.assets` reveals the resources \ + used by the model and `.model_code` will show the model code." + if self.card: + card_string = f"""
+ Show model card: + {self.card._repr_markdown_()}""" + display( + HTML(self._repr_html_()), + Markdown(card_string), + Markdown(show_string), + ) + else: + display(HTML(self._repr_html_()), Markdown(show_string)) + + def _repr_html_(self) -> Any: + # TODO: Improve Repr + # return f"Model Hash: {self.syft_model_hash}" + identifier = random.randint(1, 2**32) # nosec + result_tab_id = f"Result_{identifier}" + logs_tab_id = f"Logs_{identifier}" + model_object_type = "Model" + api_header = f"{self.server_name}/models/" + model_name = f"{self.name}" + button_html = CopyIDButton(copy_text=str(self.id), max_width=60).to_html() + + attrs = { + "Size": f"{self.mb_size:.2f} (MB)" if self.mb_size else "Unknown", + "URL": str(self.url), + "Created at": str(self.created_at), + "Updated at": self.updated_at, + "Citation": self.citation, + "Model Hash": self.syft_model_hash, + } + attrs_html = generate_attr_html(attrs) + template = Template(model_repr_template) + return template.substitute( + model_object_type=model_object_type, + api_header=api_header, + model_name=model_name, + button_html=button_html, + attrs_html=attrs_html, + identifier=identifier, + result_tab_id=result_tab_id, + logs_tab_id=logs_tab_id, + ) + + @property + def assets(self) -> DictTuple[str, ModelAsset]: + return DictTuple((asset.name, asset) for asset in self.asset_list) + + def _old_repr_markdown_(self) -> str: + _repr_str = f"Syft Model: {self.name}\n" + _repr_str += "Assets:\n" + for asset in self.asset_list: + if asset.description is not None: + _repr_str += f"\t{asset.name}: {asset.description.text}\n\n" + else: + _repr_str += f"\t{asset.name}\n\n" + if self.citation: + _repr_str += f"Citation: {self.citation}\n" + if self.url: + _repr_str += f"URL: {self.url}\n" + if self.card: + _repr_str += f"card:\n{self.card.text}\n" + return as_markdown_python_code(_repr_str) + + def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: + # return self._old_repr_markdown_() + return self._markdown_() + + def _markdown_(self) -> str: + _repr_str = f"Syft Model: {self.name}\n\n" + _repr_str += "Assets:\n\n" + for asset in self.asset_list: + if asset.description is not None: + _repr_str += f"\t{asset.name}: {asset.description.text}\n\n" + else: + _repr_str += f"\t{asset.name}\n\n" + if self.citation: + _repr_str += f"Citation: {self.citation}\n\n" + if self.url: + _repr_str += f"URL: {self.url}\n\n" + if self.card: + _repr_str += f"card: \n\n{self.card.text}\n\n" + if self.example_text: + _repr_str += f"Example: \n\n{self.example_text}\n\n" + return _repr_str + + # @property + # def run(self) -> Callable | None: + # warning = SyftWarning( + # message="This code was submitted by a User and could be UNSAFE." + # ) + # display(warning) + + # # 🟡 TODO: re-use the same infrastructure as the execute_byte_code function + # def wrapper(*args: Any, **kwargs: Any) -> Callable | SyftError: + # try: + # filtered_kwargs = {} + # on_private_data, on_mock_data = False, False + # for k, v in kwargs.items(): + # filtered_kwargs[k], arg_type = debox_asset(v) + # on_private_data = ( + # on_private_data or arg_type == ArgumentType.PRIVATE + # ) + # on_mock_data = on_mock_data or arg_type == ArgumentType.MOCK + + # if on_private_data: + # display( + # SyftInfo( + # message="The result you see is computed on PRIVATE data." + # ) + # ) + # if on_mock_data: + # display( + # SyftInfo(message="The result you see is computed on MOCK data.") + # ) + + # # remove the decorator + # inner_function = ast.parse(self.raw_code).body[0] + # inner_function.decorator_list = [] + # # compile the function + # raw_byte_code = compile_byte_code(unparse(inner_function)) + # # load it + # exec(raw_byte_code) # nosec + # # execute it + # evil_string = f"{self.service_func_name}(**filtered_kwargs)" + # result = eval(evil_string, None, locals()) # nosec + # # return the results + # return result + # except Exception as e: + # return SyftError(f"Failed to execute 'run'. Error: {e}") + + # return wrapper + + +@serializable() +class CreateModel(Model): + # version + __canonical_name__ = "CreateModel" + __version__ = SYFT_OBJECT_VERSION_1 + + __repr_attrs__ = ["name", "url"] + + code: SubmitModelCode + code_action_id: UID | None = None + asset_list: list[Any] = [] + created_at: DateTime | None = None # type: ignore[assignment] + model_config = ConfigDict(validate_assignment=True) + server_uid: UID | None = None # type: ignore[assignment] + autogenerate_mock: bool = False + + def __init__( + self, + code: type | SubmitModelCode, + **kwargs: Any, + ) -> None: + # Generate mock assets if autogenerate_mock is True + if "autogenerate_mock" in kwargs and kwargs["autogenerate_mock"]: + asset_list = kwargs.get("asset_list", []) + for asset in asset_list: + if asset.mock is None and asset.data is not None: + asset.mock = code.generate_mock_assets(asset.data) + + # Convert class to SubmitModelCode + if isinstance(code, type) and issubclass(code, SyftModelClass): + code = syft_model(name=code.__name__)(code) + + super().__init__(**kwargs, code=code) + + def set_card(self, card: str) -> None: + self.card = MarkdownDescription(text=card) + + def add_citation(self, citation: str) -> None: + self.citation = citation + + def add_url(self, url: str) -> None: + self.url = url + + def add_contributor( + self, + name: str, + email: str, + role: Enum | str | None = None, + phone: str | None = None, + note: str | None = None, + ) -> SyftSuccess | SyftError: + try: + _role_str = role.value if isinstance(role, Enum) else role + contributor = Contributor( + name=name, role=_role_str, email=email, phone=phone, note=note + ) + if contributor in self.contributors: + return SyftError( + message=f"Contributor with email: '{email}' already exists in '{self.name}' Model." + ) + self.contributors.add(contributor) + return SyftSuccess( + message=f"Contributor '{name}' added to '{self.name}' Model." + ) + except Exception as e: + return SyftError(message=f"Failed to add contributor. Error: {e}") + + def add_asset( + self, asset: CreateModelAsset, force_replace: bool = False + ) -> SyftSuccess | SyftError: + for i, existing_asset in enumerate(self.asset_list): + if existing_asset.name == asset.name: + if not force_replace: + return SyftError( + message=f"""Asset "{asset.name}" already exists in '{self.name}' Model.""" + """ Use add_asset(asset, force_replace=True) to replace.""" + ) + else: + self.asset_list[i] = asset + return SyftSuccess( + f"Asset {asset.name} has been successfully replaced." + ) + + self.asset_list.append(asset) + + return SyftSuccess( + message=f"Asset '{asset.name}' added to '{self.name}' Model." + ) + + def remove_asset(self, name: str) -> SyftSuccess | SyftError: + asset_to_remove = None + for asset in self.asset_list: + if asset.name == name: + asset_to_remove = asset + break + + if asset_to_remove is None: + return SyftError(message=f"No asset exists with name: {name}") + self.asset_list.remove(asset_to_remove) + return SyftSuccess( + message=f"Asset '{self.name}' removed from '{self.name}' Model." + ) + + def check(self) -> Result[SyftSuccess, list[SyftError]]: + errors = [] + for asset in self.asset_list: + result = asset.check() + if not result: + errors.append(result) + if len(errors): + return Err(errors) + return Ok(SyftSuccess(message="Model is Valid")) + + +def add_msg_creation_time(context: TransformContext) -> TransformContext: + if context.output is None: + return context + + context.output["created_at"] = DateTime.now() + return context + + +def add_default_server_uid(context: TransformContext) -> TransformContext: + if context.output is not None: + if context.output["server_uid"] is None and context.server is not None: + context.output["server_uid"] = context.server.id + else: + raise ValueError(f"{context}'s output is None. No transformation happened") + return context + + +def add_asset_hash(context: TransformContext) -> TransformContext: + # relative + + if context.output is None: + return context + + if context.server is None: + raise ValueError("Context should have a server attached to it.") + + action_id = context.output["action_id"] + if action_id is not None: + action_service = context.server.get_service(ActionService) + # Q: Why is service returning an result object [Ok, Err]? + action_obj = action_service.get(context=context, uid=action_id) + + if action_obj.is_err(): + return SyftError(f"Failed to get action object with id {action_obj.err()}") + # NOTE: for a TwinObject, this hash of the private data + context.output["asset_hash"] = action_obj.ok().hash() + else: + raise ValueError("Model Asset must have an action_id to generate a hash") + + return context + + +@transform(CreateModelAsset, ModelAsset) +def createmodelasset_to_asset() -> list[Callable]: + return [generate_id, add_msg_creation_time, add_default_server_uid, add_asset_hash] + + +def convert_asset(context: TransformContext) -> TransformContext: + if context.output is None: + return context + + assets = context.output.pop("asset_list", []) + for idx, create_asset in enumerate(assets): + asset_context = TransformContext.from_context(obj=create_asset, context=context) + if isinstance(create_asset, CreateModelAsset): + try: + assets[idx] = create_asset.to(ModelAsset, context=asset_context) + except Exception as e: + raise e + elif isinstance(create_asset, ModelAsset): + assets[idx] = create_asset + context.output["asset_list"] = assets + + return context + + +def add_current_date(context: TransformContext) -> TransformContext: + if context.output is None: + return context + + current_date = datetime.now() + formatted_date = current_date.strftime("%b %d, %Y") + context.output["updated_at"] = formatted_date + + return context + + +def add_model_hash(context: TransformContext) -> TransformContext: + # relative + + if context.output is None: + return context + + if context.server is None: + raise ValueError("Context should have a server attached to it.") + + self_id = context.output["id"] + if self_id is not None: + action_service = context.server.get_service(ActionService) + # Q: Why is service returning an result object [Ok, Err]? + model_ref_action_obj = action_service.get(context=context, uid=self_id) + + if model_ref_action_obj.is_err(): + return SyftError( + f"[Model]Failed to get action object with id {model_ref_action_obj.err()}" + ) + context.output["syft_model_hash"] = model_ref_action_obj.ok().hash( + context=context + ) + else: + raise ValueError("Model must have an valid ID") + + return context + + +def add_server_uid(context: TransformContext) -> TransformContext: + if context.output is None: + return context + if context.server: + context.output["server_uid"] = context.server.id + return context + + +@transform(CreateModel, Model) +def createmodel_to_model() -> list[Callable]: + return [ + generate_id, + add_msg_creation_time, + validate_url, + # generate_mock, + convert_asset, + add_current_date, + add_model_hash, + add_server_uid, + ] + + +@serializable() +class ModelRef(ActionObject): + __canonical_name__ = "ModelRef" + __version__ = SYFT_OBJECT_VERSION_1 + + syft_internal_type: ClassVar[type] = list[UID] + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + [ + "ref_objs", + "load_model", + "load_data", + "store_ref_objs_to_store", + ] + ref_objs: list = [] # Contains the loaded data + + # Schema: + # [model_code_id, asset1_id, asset2_id, ...] + + def store_ref_objs_to_store( + self, context: AuthedServiceContext, clear_ref_objs: bool = False + ) -> SyftError | None: + admin_client = context.server.root_client + + if not self.ref_objs: + return SyftError(message="No ref_objs to store in Model Ref") + + for ref_obj in self.ref_objs: + res = admin_client.services.action.set(ref_obj) + if isinstance(res, SyftError): + return res + + if clear_ref_objs: + self.ref_objs = [] + + model_ref_res = admin_client.services.action.set(self) + if isinstance(model_ref_res, SyftError): + return model_ref_res + + return None + + def hash( + self, + recalculate: bool = False, + context: TransformContext | None = None, + client: SyftClient | None = None, + ) -> str: + if context is None and client is None: + raise ValueError( + "Either context or client should be provided to ModelRef.hash()" + ) + if context and context.server is None: + raise ValueError("Context should have a server attached to it.") + + self.syft_action_data_hash: str | None + if not recalculate and self.syft_action_data_hash: + return self.syft_action_data_hash + + if not self.ref_objs: + if context: + action_objs = self.load_data(context) + else: + action_objs = self.load_data(self_client=client) + else: + action_objs = self.ref_objs + + hash_items = [action_obj.hash() for action_obj in action_objs] + hash_bytes = serialize(hash_items, to_bytes=True) + hash_str = hashlib.sha256(hash_bytes).hexdigest() + self.syft_action_data_hash = hash_str + return self.syft_action_data_hash + + def load_data( + self, + context: AuthedServiceContext | None = None, + self_client: SyftClient | None = None, + wrap_ref_to_obj: bool = False, + unwrap_action_data: bool = True, + remote_client: SyftClient | None = None, + ) -> list: + if context is None and self_client is None: + raise ValueError( + "Either context or client should be provided to ModelRef.load_data()" + ) + + client = context.server.root_client if context else self_client + + code_action_id = self.syft_action_data[0] + asset_action_ids = self.syft_action_data[1::] + + model = client.api.services.action.get(code_action_id) + + if isinstance(model, OkErr): + if model.is_err(): + return SyftError(message=f"Failed to load model code:{model.err()}") + model = model.ok() + + asset_list = [] + for asset_action_id in asset_action_ids: + action_object = client.api.services.action.get(asset_action_id) + if isinstance(action_object, OkErr): + if action_object.is_err(): + return SyftError( + message=f"Failed to load asset:{action_object.err()}" + ) + action_object = action_object.ok() + action_data = action_object.syft_action_data + + # Save to blob storage of remote client if provided + if remote_client is not None: + action_object.syft_blob_storage_entry_id = None + blob_res = action_object._save_to_blob_storage(client=remote_client) + # For smaller data, we do not store in blob storage + # so for the cases, where we store in blob storage + # we need to clear the cache , to avoid sending the data again + # stdlib + + action_object.syft_blob_storage_entry_id = cast( + UID | None, action_object.syft_blob_storage_entry_id + ) + if action_object.syft_blob_storage_entry_id: + action_object._clear_cache() + if isinstance(blob_res, SyftError): + return blob_res + # TODO: fix Tech Debt + # Currently, Setting the Location of the object to the remote client + # As this is later used by the enclave to fetch the syft_action_data + # in reload_cache method of action object + # This is a quick fix to address the same + action_object._set_obj_location_( + remote_client.id, context.server.signing_key.verify_key + ) + asset_list.append(action_data if unwrap_action_data else action_object) + + loaded_data = [model] + asset_list + if wrap_ref_to_obj: + self.ref_objs = loaded_data + + return loaded_data + + def load_model(self, context: AuthedServiceContext) -> SyftModelClass: + loaded_data = self.load_data(context) + model = loaded_data[0] + asset_list = loaded_data[1::] + + loaded_model = model(assets=asset_list) + return loaded_model diff --git a/packages/syft/src/syft/service/model/model_html_template.py b/packages/syft/src/syft/service/model/model_html_template.py new file mode 100644 index 00000000000..08bb92f59fb --- /dev/null +++ b/packages/syft/src/syft/service/model/model_html_template.py @@ -0,0 +1,225 @@ +# stdlib + +# relative +from ...util.notebook_ui.styles import CSS_CODE +from ...util.notebook_ui.styles import JS_DOWNLOAD_FONTS + +type_html = """ +
+ + ${model_object_type} +
+""" + +header_line_html = ( + """ +
+
${api_header}
+
+
+
""" + + type_html + + """ + ${model_name} +
+ ${button_html} +
+
+""" +) # noqa: E501 + + +def generate_attr_html(attrs: dict[str, str]) -> str: + attrs_html = ( + """
""" + ) + + for key in attrs: + attrs_html += f""" +
+ {key}: + {attrs[key]} +
+ """ + + attrs_html += """ +
+ """ + return attrs_html + + +tabs_html = """ +
+
+
+ + Result + +
+
+ Logs +
+
+
+""" + +assets_html = """
+
+ ${result} +
+
+""" + +logs_html = """ + + +
+ 
+
+
+""" + +# TODO: add style change for selected tab +onclick_html = """ +""" + +model_card_html = """ + + ${model_card} + +""" + +model_repr_template = ( + f""" + +
+ + +{JS_DOWNLOAD_FONTS} + + + +{CSS_CODE} + + + +{header_line_html} + +""" + + ( + """ + +${attrs_html} + +""" + ) + + """ + +
+
+ +""" +) + + +asset_repr_template = ( + f""" + +
+ + +{JS_DOWNLOAD_FONTS} + + + +{CSS_CODE} + + + +{header_line_html} + +""" + + ( + """ + +${attrs_html} + +""" + ) + + """ +
+
+ +""" +) diff --git a/packages/syft/src/syft/service/model/model_service.py b/packages/syft/src/syft/service/model/model_service.py new file mode 100644 index 00000000000..85710297d2c --- /dev/null +++ b/packages/syft/src/syft/service/model/model_service.py @@ -0,0 +1,156 @@ +# stdlib +from collections.abc import Collection +from collections.abc import Sequence + +# relative +from ...serde.serializable import serializable +from ...store.document_store import DocumentStore +from ...types.dicttuple import DictTuple +from ...types.uid import UID +from ...util.telemetry import instrument +from ..action.action_permissions import ActionObjectPermission +from ..action.action_permissions import ActionPermission +from ..context import AuthedServiceContext +from ..response import SyftError +from ..response import SyftSuccess +from ..service import AbstractService +from ..service import SERVICE_TO_TYPES +from ..service import TYPE_TO_SERVICE +from ..service import service_method +from ..user.user_roles import DATA_OWNER_ROLE_LEVEL +from ..user.user_roles import GUEST_ROLE_LEVEL +from ..warnings import CRUDReminder +from ..warnings import HighSideCRUDWarning +from .model import CreateModel +from .model import Model +from .model import ModelPageView +from .model_stash import ModelStash + + +def _paginate_collection( + collection: Collection, + page_size: int | None = 0, + page_index: int | None = 0, +) -> slice | None: + if page_size is None or page_size <= 0: + return None + + # If chunk size is defined, then split list into evenly sized chunks + total = len(collection) + page_index = 0 if page_index is None else page_index + + if page_size > total or page_index >= total // page_size or page_index < 0: + return None + + start = page_size * page_index + stop = min(page_size * (page_index + 1), total) + return slice(start, stop) + + +def _paginate_model_collection( + models: Sequence[Model], + page_size: int | None = 0, + page_index: int | None = 0, +) -> DictTuple[str, Model] | ModelPageView: + slice_ = _paginate_collection(models, page_size=page_size, page_index=page_index) + chunk = models[slice_] if slice_ is not None else models + results = DictTuple(chunk, lambda model: model.name) + + return ( + results if slice_ is None else ModelPageView(models=results, total=len(models)) + ) + + +@instrument +@serializable(canonical_name="ModelService", version=1) +class ModelService(AbstractService): + store: DocumentStore + stash: ModelStash + + def __init__(self, store: DocumentStore) -> None: + self.store = store + self.stash = ModelStash(store=store) + + @service_method( + path="model.add", + name="add", + roles=DATA_OWNER_ROLE_LEVEL, + ) + def add( + self, context: AuthedServiceContext, model: CreateModel + ) -> SyftSuccess | SyftError: + """Add a model""" + model = model.to(Model, context=context) + + result = self.stash.set( + context.credentials, + model, + add_permissions=[ + ActionObjectPermission( + uid=model.id, permission=ActionPermission.ALL_READ + ), + ], + ) + if result.is_err(): + return SyftError(message=str(result.err())) + return SyftSuccess( + message=f"Model uploaded to '{context.server.name}'. " + f"To see the models uploaded by a client on this server, use command `[your_client].models`" + ) + + @service_method( + path="model.get_all", + name="get_all", + roles=GUEST_ROLE_LEVEL, + warning=CRUDReminder(), + ) + def get_all( + self, + context: AuthedServiceContext, + page_size: int | None = 0, + page_index: int | None = 0, + ) -> ModelPageView | DictTuple[str, Model] | SyftError: + """Get a Dataset""" + result = self.stash.get_all(context.credentials) + if not result.is_ok(): + return SyftError(message=result.err()) + + models = result.ok() + + return _paginate_model_collection( + models=models, page_size=page_size, page_index=page_index + ) + + @service_method( + path="model.delete_by_uid", + name="delete_by_uid", + roles=DATA_OWNER_ROLE_LEVEL, + warning=HighSideCRUDWarning(confirmation=True), + ) + def delete_model( + self, context: AuthedServiceContext, uid: UID + ) -> SyftSuccess | SyftError: + result = self.stash.delete_by_uid(context.credentials, uid) + if result.is_ok(): + return result.ok() + else: + return SyftError(message=result.err()) + + @service_method( + path="model.get_by_uid", + name="get_by_uid", + roles=GUEST_ROLE_LEVEL, + warning=CRUDReminder(), + ) + def get_by_uid( + self, context: AuthedServiceContext, uid: UID + ) -> SyftSuccess | SyftError: + result = self.stash.get_by_uid(context.credentials, uid) + if result.is_ok(): + return result.ok() + else: + return SyftError(message=result.err()) + + +TYPE_TO_SERVICE[Model] = ModelService +SERVICE_TO_TYPES[ModelService].update({Model}) diff --git a/packages/syft/src/syft/service/model/model_stash.py b/packages/syft/src/syft/service/model/model_stash.py new file mode 100644 index 00000000000..01003ed97e9 --- /dev/null +++ b/packages/syft/src/syft/service/model/model_stash.py @@ -0,0 +1,33 @@ +# third party +from result import Result + +# relative +from ...serde.serializable import serializable +from ...server.credentials import SyftVerifyKey +from ...store.document_store import BaseUIDStoreStash +from ...store.document_store import DocumentStore +from ...store.document_store import PartitionKey +from ...store.document_store import PartitionSettings +from ...store.document_store import QueryKeys +from ...util.telemetry import instrument +from .model import Model + +NamePartitionKey = PartitionKey(key="name", type_=str) + + +@instrument +@serializable(canonical_name="ModelStash", version=1) +class ModelStash(BaseUIDStoreStash): + object_type = Model + settings: PartitionSettings = PartitionSettings( + name=Model.__canonical_name__, object_type=Model + ) + + def __init__(self, store: DocumentStore) -> None: + super().__init__(store=store) + + def get_by_name( + self, credentials: SyftVerifyKey, name: str + ) -> Result[Model | None, str]: + qks = QueryKeys(qks=[NamePartitionKey.with_obj(name)]) + return self.query_one(credentials=credentials, qks=qks) diff --git a/packages/syft/src/syft/service/network/association_request.py b/packages/syft/src/syft/service/network/association_request.py index ad0d358dd4b..e6bc86be29b 100644 --- a/packages/syft/src/syft/service/network/association_request.py +++ b/packages/syft/src/syft/service/network/association_request.py @@ -11,6 +11,7 @@ from ...client.client import SyftClient from ...serde.serializable import serializable from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from ..context import ChangeContext from ..request.request import Change from ..response import SyftError @@ -20,7 +21,7 @@ @serializable() -class AssociationRequestChange(Change): +class AssociationRequestChangeV1(Change): __canonical_name__ = "AssociationRequestChange" __version__ = SYFT_OBJECT_VERSION_1 @@ -28,7 +29,15 @@ class AssociationRequestChange(Change): remote_peer: ServerPeer challenge: bytes - __repr_attrs__ = ["self_server_route", "remote_peer"] + +@serializable() +class AssociationRequestChange(Change): + __canonical_name__ = "AssociationRequestChange" + __version__ = SYFT_OBJECT_VERSION_2 + + remote_peer: ServerPeer + + __repr_attrs__ = ["remote_peer"] def _run( self, context: ChangeContext, apply: bool @@ -85,7 +94,7 @@ def _run( ) remote_client = remote_client.ok() random_challenge = secrets.token_bytes(16) - remote_res = remote_client.api.services.network.ping( + remote_res = remote_client.api.services.network.challenge_nonce( challenge=random_challenge ) except Exception as e: @@ -112,15 +121,6 @@ def _run( if result.is_err(): return Err(SyftError(message=str(result.err()))) - # this way they can match up who we are with who they think we are - # Sending a signed messages for the peer to verify - self_server_peer = self.self_server_route.validate_with_context( - context=service_ctx - ) - - if isinstance(self_server_peer, SyftError): - return Err(self_server_peer) - return Ok( SyftSuccess( message=f"Routes successfully added for peer: {self.remote_peer.name}" diff --git a/packages/syft/src/syft/service/network/network_service.py b/packages/syft/src/syft/service/network/network_service.py index 24f117b7323..7659d0e1f07 100644 --- a/packages/syft/src/syft/service/network/network_service.py +++ b/packages/syft/src/syft/service/network/network_service.py @@ -18,11 +18,8 @@ from ...server.credentials import SyftVerifyKey from ...server.worker_settings import WorkerSettings from ...service.settings.settings import ServerSettings -from ...store.document_store import BaseUIDStoreStash from ...store.document_store import DocumentStore from ...store.document_store import PartitionKey -from ...store.document_store import PartitionSettings -from ...store.document_store import QueryKeys from ...types.server_url import ServerURL from ...types.transforms import TransformContext from ...types.transforms import keep @@ -36,7 +33,6 @@ from ...util.util import prompt_warning_message from ...util.util import str_to_bool from ..context import AuthedServiceContext -from ..data_subject.data_subject import NamePartitionKey from ..metadata.server_metadata import ServerMetadata from ..request.request import Request from ..request.request import RequestStatus @@ -53,6 +49,7 @@ from ..user.user_roles import GUEST_ROLE_LEVEL from ..warnings import CRUDWarning from .association_request import AssociationRequestChange +from .network_stash import NetworkStash from .reverse_tunnel_service import ReverseTunnelService from .routes import HTTPServerRoute from .routes import PythonServerRoute @@ -81,81 +78,6 @@ class ServerPeerAssociationStatus(Enum): PEER_NOT_FOUND = "PEER_NOT_FOUND" -@instrument -@serializable(canonical_name="NetworkStash", version=1) -class NetworkStash(BaseUIDStoreStash): - object_type = ServerPeer - settings: PartitionSettings = PartitionSettings( - name=ServerPeer.__canonical_name__, object_type=ServerPeer - ) - - def __init__(self, store: DocumentStore) -> None: - super().__init__(store=store) - - def get_by_name( - self, credentials: SyftVerifyKey, name: str - ) -> Result[ServerPeer | None, str]: - qks = QueryKeys(qks=[NamePartitionKey.with_obj(name)]) - return self.query_one(credentials=credentials, qks=qks) - - def update( - self, - credentials: SyftVerifyKey, - peer_update: ServerPeerUpdate, - has_permission: bool = False, - ) -> Result[ServerPeer, str]: - valid = self.check_type(peer_update, ServerPeerUpdate) - if valid.is_err(): - return SyftError(message=valid.err()) - return super().update(credentials, peer_update, has_permission=has_permission) - - def create_or_update_peer( - self, credentials: SyftVerifyKey, peer: ServerPeer - ) -> Result[ServerPeer, str]: - """ - Update the selected peer and its route priorities if the peer already exists - If the peer does not exist, simply adds it to the database. - - Args: - credentials (SyftVerifyKey): The credentials used to authenticate the request. - peer (ServerPeer): The peer to be updated or added. - - Returns: - Result[ServerPeer, str]: The updated or added peer if the operation - was successful, or an error message if the operation failed. - """ - valid = self.check_type(peer, ServerPeer) - if valid.is_err(): - return SyftError(message=valid.err()) - existing: Result | ServerPeer = self.get_by_uid( - credentials=credentials, uid=peer.id - ) - if existing.is_ok() and existing.ok(): - existing_peer = existing.ok() - existing_peer.update_routes(peer.server_routes) - peer_update = ServerPeerUpdate( - id=peer.id, server_routes=existing_peer.server_routes - ) - result = self.update(credentials, peer_update) - else: - result = self.set(credentials, peer) - return result - - def get_by_verify_key( - self, credentials: SyftVerifyKey, verify_key: SyftVerifyKey - ) -> Result[ServerPeer | None, SyftError]: - qks = QueryKeys(qks=[VerifyKeyPartitionKey.with_obj(verify_key)]) - return self.query_one(credentials, qks) - - def get_by_server_type( - self, credentials: SyftVerifyKey, server_type: ServerType - ) -> Result[list[ServerPeer], SyftError]: - qks = QueryKeys(qks=[ServerTypePartitionKey.with_obj(server_type)]) - return self.query_all( - credentials=credentials, qks=qks, order_by=OrderByNamePartitionKey - ) - - @instrument @serializable(canonical_name="NetworkService", version=1) class NetworkService(AbstractService): @@ -278,27 +200,10 @@ def add_peer( self, context: AuthedServiceContext, peer: ServerPeer, - challenge: bytes, - self_server_route: ServerRoute, - verify_key: SyftVerifyKey, ) -> Request | SyftSuccess | SyftError: """Add a Network Server Peer. Called by a remote server to add itself as a peer for the current server. """ - # Using the verify_key of the peer to verify the signature - # It is also our single source of truth for the peer - if peer.verify_key != context.credentials: - return SyftError( - message=( - f"The {type(peer).__name__}.verify_key: " - f"{peer.verify_key} does not match the signature of the message" - ) - ) - - if verify_key != context.server.verify_key: - return SyftError( - message="verify_key does not match the remote server's verify_key for add_peer" - ) # check if the peer already is a server peer existing_peer_res = self.stash.get_by_uid(context.server.verify_key, peer.id) @@ -340,9 +245,7 @@ def add_peer( return association_request # only create and submit a new request if there is no requests yet # or all previous requests have been rejected - association_request_change = AssociationRequestChange( - self_server_route=self_server_route, challenge=challenge, remote_peer=peer - ) + association_request_change = AssociationRequestChange(remote_peer=peer) submit_request = SubmitRequest( changes=[association_request_change], requesting_user_verify_key=context.credentials, @@ -360,11 +263,13 @@ def add_peer( return request - @service_method(path="network.ping", name="ping", roles=GUEST_ROLE_LEVEL) - def ping( + @service_method( + path="network.challenge_nonce", name="challenge_nonce", roles=GUEST_ROLE_LEVEL + ) + def challenge_nonce( self, context: AuthedServiceContext, challenge: bytes ) -> bytes | SyftError: - """To check alivesness/authenticity of a peer""" + """To check authenticity of the remote server""" # # Only the root user can ping the server to check its state # if context.server.verify_key != context.credentials: @@ -379,6 +284,47 @@ def ping( return challenge_signature + @service_method(path="network.ping", name="ping", roles=GUEST_ROLE_LEVEL) + def ping(self, context: AuthedServiceContext) -> SyftSuccess: + """To check liveness of the remote server""" + return SyftSuccess( + message=f"Reply from remote server:{context.server.name}-<{context.server.id}>" + ) + + @service_method( + path="network.ping_peer", + name="ping_peer", + roles=GUEST_ROLE_LEVEL, + ) + def ping_peer( + self, context: AuthedServiceContext, verify_key: SyftVerifyKey + ) -> SyftSuccess | SyftError: + """Ping a remote server by its verify key""" + + remote_peer = self.stash.get_by_verify_key( + credentials=context.server.verify_key, verify_key=verify_key + ) + if remote_peer.is_err(): + return SyftError( + message=f"Failed to query peer from stash. Err: {remote_peer}" + ) + + remote_peer = remote_peer.ok() + if remote_peer is None: + return SyftError(message=f"Peer not found with verify key: {verify_key}") + try: + remote_client = remote_peer.client_with_context(context=context) + if remote_client.is_err(): + return SyftError( + message=f"Failed to create remote client for peer: {remote_peer}. Error: {remote_client.err()}" + ) + remote_client = remote_client.ok() + return remote_client.api.services.network.ping() + except Exception as e: + return SyftError( + message=f"Cannot Ping Remote Peer: {remote_peer}. Error: {e}" + ) + @service_method( path="network.check_peer_association", name="check_peer_association", diff --git a/packages/syft/src/syft/service/network/network_stash.py b/packages/syft/src/syft/service/network/network_stash.py new file mode 100644 index 00000000000..3459584adcf --- /dev/null +++ b/packages/syft/src/syft/service/network/network_stash.py @@ -0,0 +1,96 @@ +# third party +from result import Result + +# relative +from ...abstract_server import ServerType +from ...serde.serializable import serializable +from ...server.credentials import SyftVerifyKey +from ...store.document_store import BaseUIDStoreStash +from ...store.document_store import DocumentStore +from ...store.document_store import PartitionKey +from ...store.document_store import PartitionSettings +from ...store.document_store import QueryKeys +from ...util.telemetry import instrument +from ..data_subject.data_subject import NamePartitionKey +from ..response import SyftError +from .server_peer import ServerPeer +from .server_peer import ServerPeerUpdate + +VerifyKeyPartitionKey = PartitionKey(key="verify_key", type_=SyftVerifyKey) +ServerTypePartitionKey = PartitionKey(key="server_type", type_=ServerType) +OrderByNamePartitionKey = PartitionKey(key="name", type_=str) + + +@instrument +@serializable(canonical_name="NetworkStash", version=1) +class NetworkStash(BaseUIDStoreStash): + object_type = ServerPeer + settings: PartitionSettings = PartitionSettings( + name=ServerPeer.__canonical_name__, object_type=ServerPeer + ) + + def __init__(self, store: DocumentStore) -> None: + super().__init__(store=store) + + def get_by_name( + self, credentials: SyftVerifyKey, name: str + ) -> Result[ServerPeer | None, str]: + qks = QueryKeys(qks=[NamePartitionKey.with_obj(name)]) + return self.query_one(credentials=credentials, qks=qks) + + def update( + self, + credentials: SyftVerifyKey, + peer_update: ServerPeerUpdate, + has_permission: bool = False, + ) -> Result[ServerPeer, str]: + valid = self.check_type(peer_update, ServerPeerUpdate) + if valid.is_err(): + return SyftError(message=valid.err()) + return super().update(credentials, peer_update, has_permission=has_permission) + + def create_or_update_peer( + self, credentials: SyftVerifyKey, peer: ServerPeer + ) -> Result[ServerPeer, str]: + """ + Update the selected peer and its route priorities if the peer already exists + If the peer does not exist, simply adds it to the database. + + Args: + credentials (SyftVerifyKey): The credentials used to authenticate the request. + peer (ServerPeer): The peer to be updated or added. + + Returns: + Result[ServerPeer, str]: The updated or added peer if the operation + was successful, or an error message if the operation failed. + """ + valid = self.check_type(peer, ServerPeer) + if valid.is_err(): + return SyftError(message=valid.err()) + + existing = self.get_by_uid(credentials=credentials, uid=peer.id) + if existing.is_ok() and existing.ok() is not None: + existing_peer: ServerPeer = existing.ok() + existing_peer.update_routes(peer.server_routes) + peer_update = ServerPeerUpdate( + id=peer.id, server_routes=existing_peer.server_routes + ) + result = self.update(credentials, peer_update) + return result + else: + result = self.set(credentials, peer) + return result + + def get_by_verify_key( + self, credentials: SyftVerifyKey, verify_key: SyftVerifyKey + ) -> Result[ServerPeer | None, SyftError]: + qks = QueryKeys(qks=[VerifyKeyPartitionKey.with_obj(verify_key)]) + return self.query_one(credentials, qks) + + def get_by_server_type( + self, credentials: SyftVerifyKey, server_type: ServerType + ) -> Result[list[ServerPeer], SyftError]: + qks = QueryKeys(qks=[ServerTypePartitionKey.with_obj(server_type)]) + return self.query_all( + credentials=credentials, qks=qks, order_by=OrderByNamePartitionKey + ) diff --git a/packages/syft/src/syft/service/network/routes.py b/packages/syft/src/syft/service/network/routes.py index 04e758b1bdc..4f6ef2f4e0f 100644 --- a/packages/syft/src/syft/service/network/routes.py +++ b/packages/syft/src/syft/service/network/routes.py @@ -66,7 +66,9 @@ def validate_with_context( # generating a random challenge random_challenge = secrets.token_bytes(16) - challenge_signature = self_client.api.services.network.ping(random_challenge) + challenge_signature = self_client.api.services.network.challenge_nonce( + random_challenge + ) if isinstance(challenge_signature, SyftError): return challenge_signature diff --git a/packages/syft/src/syft/service/network/utils.py b/packages/syft/src/syft/service/network/utils.py index c5b9e0c084e..23693124bcc 100644 --- a/packages/syft/src/syft/service/network/utils.py +++ b/packages/syft/src/syft/service/network/utils.py @@ -1,14 +1,27 @@ # stdlib +from enum import Enum +import itertools import logging import threading import time from typing import cast +# third party +from IPython.display import HTML +from IPython.display import display + # relative +from ...client.client import SyftClient from ...serde.serializable import serializable from ...types.datetime import DateTime +from ...util.notebook_ui.components.tabulator_template import ( + build_tabulator_table_with_data, +) from ..context import AuthedServiceContext +from ..request.request import Request from ..response import SyftError +from ..response import SyftSuccess +from ..user.user_roles import ServiceRole from .network_service import NetworkService from .network_service import ServerPeerAssociationStatus from .server_peer import ServerPeer @@ -130,3 +143,132 @@ def stop(self) -> None: self.thread = None self.started_time = None logger.info("Peer health check task stopped.") + + +def exchange_routes( + clients: list[SyftClient], auto_approve: bool = False +) -> SyftError | None: + metadata = { + "name": "Connecting clients", + "columns": ["From", "To", "Status"], + } + rows = [] + + """Exchange routes between a list of clients.""" + if auto_approve: + # Check that all clients are admin clients + for client in clients: + if not client.user_role == ServiceRole.ADMIN: + return SyftError( + message=f"Client {client} is not an admin client. " + "Only admin clients can auto-approve connection requests." + ) + + for client1, client2 in itertools.combinations(clients, 2): + peer1 = ServerPeer.from_client(client1) + peer2 = ServerPeer.from_client(client2) + + client1_connection_request = client1.api.services.network.add_peer(peer2) + if isinstance(client1_connection_request, SyftError): + return SyftError( + message=f"Failed to add peer {peer2} to {client1}: {client1_connection_request}" + ) + + client2_connection_request = client2.api.services.network.add_peer(peer1) + if isinstance(client2_connection_request, SyftError): + return SyftError( + message=f"Failed to add peer {peer1} to {client2}: {client2_connection_request}" + ) + + if auto_approve: + if isinstance(client1_connection_request, Request): + res1 = client1_connection_request.approve() + if isinstance(res1, SyftError): + return SyftError( + message=f"Failed to approve connection request between {client1} and {client2}: {res1}" + ) + if isinstance(client2_connection_request, Request): + res2 = client2_connection_request.approve() + if isinstance(res2, SyftError): + return SyftError( + message=f"Failed to approve connection request between {client2} and {client1}: {res2}" + ) + + rows += [ + { + "From": f"{client1.name}-{client1.id.short()}", # type: ignore + "To": f"{client2.name}-{client2.id.short()}", # type: ignore + "Status": "Connected ✅", + }, + { + "From": f"{client2.name}-{client2.id.short()}", # type: ignore + "To": f"{client1.name}-{client1.id.short()}", # type: ignore + "Status": "Connected ✅", + }, + ] + else: + client1_res = ( + "Connected ✅" + if isinstance(client1_connection_request, SyftSuccess) + else "Request Sent 📨" + ) + client2_res = ( + "Connected ✅" + if isinstance(client2_connection_request, SyftSuccess) + else "Request Sent 📨" + ) + rows += [ + { + "From": f"{client1.name}-{client1.id.short()}", # type: ignore + "To": f"{client2.name}-{client2.id.short()}", # type: ignore + "Status": client2_res, + }, + { + "From": f"{client2.name}-{client2.id.short()}", # type: ignore + "To": f"{client1.name}-{client1.id.short()}", # type: ignore + "Status": client1_res, + }, + ] + + # third party + from IPython import get_ipython + + if get_ipython(): + display(HTML(build_tabulator_table_with_data(rows, metadata))) + else: + print(rows) + + return None + + +class NetworkTopology(Enum): + STAR = "STAR" + MESH = "MESH" + HYBRID = "HYBRID" + + +def check_route_reachability( + clients: list[SyftClient], topology: NetworkTopology = NetworkTopology.MESH +) -> SyftSuccess | SyftError: + if topology == NetworkTopology.STAR: + return SyftError(message="STAR topology is not supported yet") + elif topology == NetworkTopology.MESH: + return check_mesh_topology(clients) + else: + return SyftError(message=f"Invalid topology: {topology}") + + +def check_mesh_topology(clients: list[SyftClient]) -> SyftSuccess | SyftError: + for client in clients: + for other_client in clients: + if client == other_client: + continue + result = client.api.services.network.ping_peer( + verify_key=other_client.root_verify_key + ) + if isinstance(result, SyftError): + return SyftError( + message=f"{client.name}-<{client.id}> - cannot reach" + + f"{other_client.name}-<{other_client.id} - {result.message}" + ) + return SyftSuccess(message="All clients are reachable") diff --git a/packages/syft/src/syft/service/notifier/notifier.py b/packages/syft/src/syft/service/notifier/notifier.py index 26dafe34e44..e3bda3667ef 100644 --- a/packages/syft/src/syft/service/notifier/notifier.py +++ b/packages/syft/src/syft/service/notifier/notifier.py @@ -100,9 +100,9 @@ def send( sender=self.sender, receiver=receiver_email, subject=subject, body=body ) return Ok("Email sent successfully!") - except Exception: + except Exception as e: return Err( - "Some notifications failed to be delivered. Please check the health of the mailing server." + f"Some notifications failed to be delivered. Please check the health of the mailing server. {e}" ) diff --git a/packages/syft/src/syft/service/notifier/smtp_client.py b/packages/syft/src/syft/service/notifier/smtp_client.py index 1f4df6531e5..def169e3d2d 100644 --- a/packages/syft/src/syft/service/notifier/smtp_client.py +++ b/packages/syft/src/syft/service/notifier/smtp_client.py @@ -28,26 +28,34 @@ def __init__( self.port = port def send(self, sender: str, receiver: list[str], subject: str, body: str) -> None: - if not (subject and body and receiver): - raise ValueError("Subject, body, and recipient email(s) are required") + # TODO remove the below comment after testing + # print( + # "sending email", self.server, self.username, self.password, sender, receiver + # ) + try: + if not (subject and body and receiver): + raise ValueError("Subject, body, and recipient email(s) are required") - msg = MIMEMultipart("alternative") - msg["From"] = sender - msg["To"] = ", ".join(receiver) - msg["Subject"] = subject - msg.attach(MIMEText(body, "html")) + msg = MIMEMultipart("alternative") + msg["From"] = sender + msg["To"] = ", ".join(receiver) + msg["Subject"] = subject + msg.attach(MIMEText(body, "html")) - with smtplib.SMTP( - self.server, self.port, timeout=self.SOCKET_TIMEOUT - ) as server: - server.ehlo() - if server.has_extn("STARTTLS"): - server.starttls() + with smtplib.SMTP( + self.server, self.port, timeout=self.SOCKET_TIMEOUT + ) as server: server.ehlo() - server.login(self.username, self.password) - text = msg.as_string() - server.sendmail(sender, ", ".join(receiver), text) - # TODO: Add error handling + if server.has_extn("STARTTLS"): + server.starttls() + server.ehlo() + server.login(self.username, self.password) + text = msg.as_string() + server.sendmail(sender, ", ".join(receiver), text) + # TODO: Add error handling + except Exception as e: + print("Got exception sending mail", e) + raise e @classmethod def check_credentials( diff --git a/packages/syft/src/syft/service/policy/policy.py b/packages/syft/src/syft/service/policy/policy.py index ba1ae048f95..ac7c9285086 100644 --- a/packages/syft/src/syft/service/policy/policy.py +++ b/packages/syft/src/syft/service/policy/policy.py @@ -33,6 +33,7 @@ from ...serde.recursive_primitives import recursive_serde_register_type from ...serde.serializable import serializable from ...server.credentials import SyftVerifyKey +from ...service.enclave.enclave import EnclaveInstance from ...store.document_store import PartitionKey from ...types.datetime import DateTime from ...types.syft_object import SYFT_OBJECT_VERSION_1 @@ -146,6 +147,7 @@ def partition_by_server(kwargs: dict[str, Any]) -> dict[ServerIdentity, dict[str from ...client.api import ServerIdentity from ...types.twin_object import TwinObject from ..action.action_object import ActionObject + from ..model.model import Model # fetches the all the current api's connected api_list = APIRegistry.get_all_api() @@ -160,6 +162,8 @@ def partition_by_server(kwargs: dict[str, Any]) -> dict[ServerIdentity, dict[str uid = v.custom_function_actionobject_id() if isinstance(v, Asset): uid = v.action_id + if isinstance(v, Model): + uid = v.id if not isinstance(uid, UID): raise Exception(f"Input {k} must have a UID not {type(v)}") @@ -350,6 +354,40 @@ def retrieve_item_from_db(id: UID, context: AuthedServiceContext) -> ActionObjec return value.ok() +@serializable() +class RuntimePolicyCondition(SyftObject): + __canonical_name__: str = "RuntimePolicyCondition" + __version__ = SYFT_OBJECT_VERSION_1 + + +@serializable() +class InitCondition(RuntimePolicyCondition): + __canonical_name__: str = "InitCondition" + __version__ = SYFT_OBJECT_VERSION_1 + + manual_init: bool = True + + +@serializable() +class RunCondition(RuntimePolicyCondition): + __canonical_name__: str = "RunCondition" + __version__ = SYFT_OBJECT_VERSION_1 + + manual_start: bool = True + manual_asset_transfer: bool = True + requester_can_start: bool = True + + +@serializable() +class StopCondition(RuntimePolicyCondition): + __canonical_name__: str = "StopCondition" + __version__ = SYFT_OBJECT_VERSION_1 + + results_downloaded: bool = True + requester_access_only: bool = False + timeout_minutes: int = 60 + + class InputPolicy(Policy): __canonical_name__ = "InputPolicy" __version__ = SYFT_OBJECT_VERSION_1 @@ -574,32 +612,33 @@ def retrieve_from_db( # relative from ...service.action.action_object import TwinMode + if context.server.server_type not in {ServerType.DATASITE, ServerType.ENCLAVE}: + raise Exception( + f"Invalid Server Type for Code Submission:{context.server.server_type}" + ) action_service = context.server.get_service("actionservice") - code_inputs = {} + code_inputs: dict = {} # When we are retrieving the code from the database, we need to use the server's # verify key as the credentials. This is because when we approve the code, we # we allow the private data to be used only for this specific code. # but we are not modifying the permissions of the private data + root_context = context.as_root_context() - root_context = AuthedServiceContext( - server=context.server, credentials=context.server.verify_key - ) - if context.server.server_type == ServerType.DATASITE: - for var_name, arg_id in allowed_inputs.items(): - kwarg_value = action_service._get( - context=root_context, - uid=arg_id, - twin_mode=TwinMode.NONE, - has_permission=True, - ) - if kwarg_value.is_err(): - return Err(kwarg_value.err()) - code_inputs[var_name] = kwarg_value.ok() - else: - raise Exception( - f"Invalid Server Type for Code Submission:{context.server.server_type}" + action_service = context.server.get_service("actionservice") + code_inputs = {} + + for var_name, arg_id in allowed_inputs.items(): + kwarg_value = action_service._get( + context=root_context, + uid=arg_id, + twin_mode=TwinMode.NONE, + has_permission=True, ) + if kwarg_value.is_err(): + return Err(kwarg_value.err()) + code_inputs[var_name] = kwarg_value.ok() + return Ok(code_inputs) @@ -801,6 +840,100 @@ class OutputPolicyExecuteOnce(OutputPolicyExecuteCount): SingleExecutionExactOutput = OutputPolicyExecuteOnce +@serializable() +class RuntimePolicy(Policy): + __canonical_name__ = "RuntimePolicy" + __version__ = SYFT_OBJECT_VERSION_1 + + +@serializable() +class EmptyRuntimePolicy(RuntimePolicy): + __canonical_name__ = "EmptyRuntimePolicy" + __version__ = SYFT_OBJECT_VERSION_1 + + +@serializable() +class RunOnEnclave(RuntimePolicy): + __canonical_name__ = "RunOnEnclave" + __version__ = SYFT_OBJECT_VERSION_1 + + provider: EnclaveInstance + image: str = "default-pool" + workers_num: int = 1 + init_condition: InitCondition = InitCondition() + run_condition: RunCondition = RunCondition() + stop_condition: StopCondition = StopCondition() + + @field_validator("image", mode="before") + @classmethod + def validate_image(cls, v: str) -> str: + if v != "default-pool": + raise ValueError( + 'Only the default-pool image is supported. Set image="default-pool" to continue.' + ) + return v + + @field_validator("workers_num", mode="before") + @classmethod + def validate_workers_num(cls, v: int) -> int: + if v != 1: + raise NotImplementedError( + "Currently only one worker is supported. Set workers_num=1 to proceed." + ) + return v + + @field_validator("init_condition", mode="before") + @classmethod + def validate_init_condition(cls, v: InitCondition) -> InitCondition: + if not v.manual_init: + raise NotImplementedError( + "Only manual init is supported. Set manual_init=True to proceed." + ) + return v + + @field_validator("run_condition", mode="before") + @classmethod + def validate_run_condition(cls, v: RunCondition) -> RunCondition: + if not v.manual_start: + raise NotImplementedError( + "Only manual start is supported. Set manual_start=True to proceed." + ) + if not v.manual_asset_transfer: + raise NotImplementedError( + "Only manual asset transfer to the Enclave is supported. Set manual_asset_transfer=True to proceed." + ) + if not v.requester_can_start: + raise NotImplementedError( + "Only the requester can currently start the Enclave code execution." + " Set requester_can_start=True to proceed." + ) + return v + + @field_validator("stop_condition", mode="before") + @classmethod + def validate_stop_condition(cls, v: StopCondition) -> StopCondition: + if not v.results_downloaded: + raise NotImplementedError( + "The Enclave can currently only shut down once results are downloaded." + " Set results_downloaded=True to proceed." + ) + if v.requester_access_only: + raise NotImplementedError( + "Currently we only support results sharing by all the parties." + " Set requester_access_only=False to proceed." + ) + if v.timeout_minutes != 60: + raise NotImplementedError( + "Currently we only support a timeout of 60 minutes." + " Set timeout_minutes=60 to proceed." + ) + return v + + def is_valid(self, *args: list, **kwargs: dict) -> SyftSuccess | SyftError: # type: ignore + # TODO verify validitity of the enclave instance + return SyftSuccess(message="Policy is valid.") + + @serializable(canonical_name="CustomPolicy", version=1) class CustomPolicy(type): # capture the init_kwargs transparently diff --git a/packages/syft/src/syft/service/project/distributed_project.py b/packages/syft/src/syft/service/project/distributed_project.py new file mode 100644 index 00000000000..0258af40319 --- /dev/null +++ b/packages/syft/src/syft/service/project/distributed_project.py @@ -0,0 +1,256 @@ +# stdlib +from typing import Any + +# third party +from pydantic import BaseModel +from pydantic import ConfigDict +from pydantic import Field +from pydantic import field_validator +from pydantic import model_validator +from typing_extensions import Self + +# relative +from ...client.api import ServerIdentity +from ...client.client import SyftClient +from ...client.client import SyftClientSessionCache +from ...types.uid import UID +from ...util import options +from ...util.colors import SURFACE +from ...util.util import human_friendly_join +from ..code.user_code import SubmitUserCode +from ..code.user_code import UserCode +from ..enclave.enclave import EnclaveInstance +from ..metadata.server_metadata import ServerMetadata +from ..request.request import Request +from ..request.request import RequestStatus +from ..response import SyftError +from ..response import SyftException +from .project import Project +from .project import ProjectRequest +from .project import ProjectSubmit + + +class DistributedProject(BaseModel): + model_config = ConfigDict(arbitrary_types_allowed=True) + id: UID = Field(default_factory=UID) + name: str + description: str = "" + code: UserCode | SubmitUserCode # only one code per project for this prototype + clients: dict[UID, SyftClient] = Field(default_factory=dict) + members: dict[UID, ServerIdentity] = Field(default_factory=dict) + all_projects: dict[SyftClient, Project] = Field(default_factory=dict) + project_permissions: set[str] = Field(default_factory=set) # Unused at the moment + + def _coll_repr_(self) -> dict: + return { + "name": self.name, + "description": self.description, + "pending requests": self.pending_requests, + } + + def _repr_html_(self) -> str: + return ( + f""" + + """ + + "
" + + f"

{self.name}

" + + f"

{self.description}

" + + self.requests._repr_html_() + + "
" + ) + + @classmethod + def get_by_name(cls, name: str, clients: list[SyftClient]) -> Self: + all_projects = {} + for client in clients: + project = client.projects.get_by_name(name) + if isinstance(project, SyftError): + raise SyftException(project.message) + all_projects[client] = project + + # TODO verify that DS passed all clients in the args correctly, else raise exception + # TODO verify that all the projects in the `all_projects` list are the same + project = next(iter(all_projects.values())) + description = project.description + code = project.requests[0].code # TODO fix possible errors + return cls( + name=name, description=description, code=code, all_projects=all_projects + ) + + @property + def requests(self) -> list[Request]: + requests: list[Request] = [] + for project in self.all_projects.values(): + requests.extend( + event.request + for event in project.events + if isinstance(event, ProjectRequest) + ) + return requests + + @property + def pending_requests(self) -> int: + return sum( + [request.status == RequestStatus.PENDING for request in self.requests] + ) + + @field_validator("code", mode="before") + @classmethod + def verify_code(cls, code: UserCode | SubmitUserCode) -> UserCode | SubmitUserCode: + if not code.runtime_policy_init_kwargs: + raise ValueError("Runtime policy not found in code.") + provider = code.runtime_policy_init_kwargs.get("provider") + if not provider: + raise ValueError("Provider not found in runtime policy.") + if not isinstance(provider, EnclaveInstance): + raise SyftException( + "Only `EnclaveInstance` is supported as provider for now." + ) + if isinstance(code, SubmitUserCode) and not code.id: + code.id = UID() + return code + + @field_validator("clients", mode="before") + @classmethod + def verify_clients(cls, val: list[SyftClient]) -> list[SyftClient]: + # SyftClients must be logged in by the same emails + if len(val) > 0: + emails = {client.logged_in_user for client in val} + if len(emails) > 1: + raise ValueError( + f"All clients must be logged in from the same account. Found multiple: {emails}" + ) + return val + + @model_validator(mode="after") + def _populate_auto_generated_fields(self) -> Self: + self.clients = self._get_clients_from_code() + self.members = self._get_members_from_clients() + return self + + def submit(self) -> Self: + self._pre_submit_checks() + self.all_projects = self._submit_project_to_all_clients() + return self + + def request_execution(self, blocking: bool = True) -> Any: + self._pre_execution_request_checks() + code = self.verify_code(self.code) + + # Request Enclave to be set up by its owner datasite + provider = code.runtime_policy_init_kwargs.get("provider") + owner_server_id = provider.syft_server_location + owner_client = self.clients.get(owner_server_id) + if not owner_client: + raise SyftException( + f"Can't access Syft client. You must login to {self.syft_server_location}" + ) + enclave_code_created = owner_client.api.services.enclave.request_enclave( + user_code_id=self.code.id + ) + if isinstance(enclave_code_created, SyftError): + raise SyftException(enclave_code_created.message) + + # Request each datasite to transfer their assets to the Enclave + for client in self.clients.values(): + assets_transferred = client.api.services.enclave.request_assets_upload( + user_code_id=self.code.id + ) + if isinstance(assets_transferred, SyftError): + raise SyftException(assets_transferred.message) + print(assets_transferred.message) + + result_parts = [] + for client in self.clients.values(): + result = client.api.services.enclave.request_code_execution( + user_code_id=self.code.id + ) + if isinstance(result, SyftError): + return SyftError(message=f"Enclave execution failure: {result.message}") + else: + result_parts.append(result) + + return result_parts[0] + + def _get_clients_from_code(self) -> dict[UID, SyftClient]: + if not self.code or not self.code.input_policy_init_kwargs: + return {} + + clients = { + policy.server_id: client + for policy in self.code.input_policy_init_kwargs.keys() + if + ( + # TODO use server_uid, verify_key instead as there could be multiple logged-in users to the same client + client := SyftClientSessionCache.get_client_for_server_uid( + policy.server_id + ) + ) + } + return clients + + def _get_members_from_clients(self) -> dict[UID, ServerIdentity]: + return { + server_id: self._to_server_identity(client) + for server_id, client in self.clients.items() + } + + @staticmethod + def _to_server_identity(client: SyftClient) -> ServerIdentity: + if isinstance(client, SyftClient) and client.metadata is not None: + metadata = client.metadata.to(ServerMetadata) + return metadata.to(ServerIdentity) + else: + raise SyftException(f"members must be SyftClient. Received: {type(client)}") + + def _pre_submit_checks(self) -> bool: + try: + # Check if the user can create projects + for client in self.clients.values(): + result = client.api.services.project.can_create_project() + if isinstance(result, SyftError): + raise SyftException(result.message) + except Exception: + raise SyftException("Only Data Scientists can create projects") + + return True + + def _submit_project_to_all_clients(self) -> dict[SyftClient, Project]: + projects_map: dict[SyftClient, Project] = {} + for client in self.clients.values(): + # Creating projects and code requests separately across each client + # TODO handle failures in between + new_project = ProjectSubmit( + id=self.id, + name=self.name, + description=self.description, + members=[client], + ) + new_project.create_code_request(self.code, client) + project = new_project.send() + projects_map[client] = project[0] if isinstance(project, list) else project + return projects_map + + def _pre_execution_request_checks(self) -> bool: + members_servers_pending_approval = [ + request.syft_server_location + for request in self.requests + if request.status == RequestStatus.PENDING + ] + if members_servers_pending_approval: + member_names = [ + self._get_server_name(member_server_id) + or f"Server ID: {member_server_id}" + for member_server_id in members_servers_pending_approval + ] + raise SyftException( + f"Cannot execute project as approval request is pending for {human_friendly_join(member_names)}." + ) + return True + + def _get_server_name(self, server_id: UID) -> str | None: + server_identity = self.members.get(server_id) + return server_identity.server_name if server_identity else None diff --git a/packages/syft/src/syft/service/project/project.py b/packages/syft/src/syft/service/project/project.py index 6854503ff8a..1b0b0906fbe 100644 --- a/packages/syft/src/syft/service/project/project.py +++ b/packages/syft/src/syft/service/project/project.py @@ -9,8 +9,14 @@ import textwrap import time from typing import Any +from typing import cast # third party +from IPython.display import HTML +from IPython.display import JSON +from IPython.display import Markdown +from IPython.display import display +import ipywidgets as widgets from pydantic import Field from pydantic import field_validator from rich.progress import Progress @@ -24,12 +30,18 @@ from ...serde.serialize import _serialize from ...server.credentials import SyftSigningKey from ...server.credentials import SyftVerifyKey +from ...service.attestation.attestation_cpu_report import CPUAttestationReport +from ...service.attestation.attestation_gpu_report import GPUAttestationReport +from ...service.attestation.utils import AttestationType +from ...service.attestation.utils import verify_attestation_report from ...service.metadata.server_metadata import ServerMetadata from ...store.linked_obj import LinkedObject from ...types.datetime import DateTime from ...types.identity import Identity from ...types.identity import UserIdentity +from ...types.server_url import ServerURL from ...types.syft_object import SYFT_OBJECT_VERSION_1 +from ...types.syft_object import SYFT_OBJECT_VERSION_2 from ...types.syft_object import SyftObject from ...types.syft_object import short_qual_name from ...types.transforms import TransformContext @@ -39,12 +51,19 @@ from ...util import options from ...util.colors import SURFACE from ...util.decorators import deprecated +from ...util.markdown import as_markdown_python_code from ...util.markdown import markdown_as_class_with_fields +from ...util.notebook_ui.components.sync import CopyIDButton from ...util.util import full_name_with_qualname +from ...util.util import human_friendly_join +from ...util.util import sanitize_html from ..code.user_code import SubmitUserCode +from ..code.user_code import UserCodeStatus +from ..enclave.enclave import EnclaveInstance from ..network.network_service import ServerPeer from ..network.routes import ServerRoute from ..network.routes import connection_to_route +from ..network.utils import check_route_reachability from ..request.request import Request from ..request.request import RequestStatus from ..response import SyftError @@ -55,6 +74,10 @@ from ..user.user import UserView +def get_copy_id_button_html(id: UID | str | None) -> str: + return CopyIDButton(copy_text=str(id), max_width=60).to_html() + + @serializable(canonical_name="EventAlreadyAddedException", version=1) class EventAlreadyAddedException(SyftException): pass @@ -71,6 +94,12 @@ class ProjectEvent(SyftObject): __version__ = SYFT_OBJECT_VERSION_1 __hash_exclude_attrs__ = ["event_hash", "signature"] + __table_coll_widths__ = [ + "min-content", + "auto", + "auto", + "auto", + ] # 1. Creation attrs id: UID @@ -86,6 +115,18 @@ class ProjectEvent(SyftObject): creator_verify_key: SyftVerifyKey | None = None signature: bytes | None = None # dont use in signing + def get_event_details(self) -> str: + return "<->" + + def _coll_repr_(self) -> dict[str, str | dict]: + return { + "Created at": str(self.timestamp), + "Details": { + "type": "events", + "value": self.get_event_details() + } + } + def __repr_syft_nested__(self) -> tuple[str, str]: return ( short_qual_name(full_name_with_qualname(self)), @@ -252,7 +293,7 @@ def reply(self, message: str) -> ProjectMessage: @serializable() -class ProjectRequestResponse(ProjectSubEvent): +class ProjectRequestResponseV1(ProjectSubEvent): __canonical_name__ = "ProjectRequestResponse" __version__ = SYFT_OBJECT_VERSION_1 @@ -260,13 +301,51 @@ class ProjectRequestResponse(ProjectSubEvent): @serializable() -class ProjectRequest(ProjectEventAddObject): +class ProjectRequestResponse(ProjectSubEvent): + __canonical_name__ = "ProjectRequestResponse" + __version__ = SYFT_OBJECT_VERSION_2 + + response: RequestStatus + + def get_event_details(self) -> str: + response_output = None + if self.response == RequestStatus.APPROVED: + response_output = "✅" + elif self.response == RequestStatus.REJECTED: + response_output = "❌" + else: + response_output = "🟠" + + res = f"Request ID: {get_copy_id_button_html(self.parent_event_id)}
" + res += f"Response: {response_output}" + return res + + +@serializable() +class ProjectRequestV1(ProjectEventAddObject): __canonical_name__ = "ProjectRequest" __version__ = SYFT_OBJECT_VERSION_1 linked_request: LinkedObject allowed_sub_types: list[type] = [ProjectRequestResponse] + +@serializable() +class ProjectRequest(ProjectEventAddObject): + __canonical_name__ = "ProjectRequest" + __version__ = SYFT_OBJECT_VERSION_2 + + linked_request: LinkedObject + allowed_sub_types: list[type] = [ProjectRequestResponse] + # TODO: should all events have parent_event_id by default + # then we differentiate them by allowed sub types. + parent_event_id: UID + + def get_event_details(self) -> str: + res = f"Request ID: {get_copy_id_button_html(self.id)}
" + res += f"Server ID: {get_copy_id_button_html(self.linked_request.server_uid)}" + return res + @field_validator("linked_request", mode="before") @classmethod def _validate_linked_request(cls, v: Any) -> LinkedObject: @@ -292,7 +371,9 @@ def request(self) -> Request: def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: func_name = None if len(self.request.changes) > 0: - func_name = self.request.changes[-1].code.service_func_name + last_change = self.request.changes[-1] + if last_change.code: + func_name = last_change.code.service_func_name repr_dict = { "request.status": self.request.status, "request.changes[-1].code.service_func_name": func_name, @@ -312,39 +393,467 @@ def accept_by_depositing_result( # TODO: To add deny requests, when deny functionality is added - def status(self, project: Project) -> SyftInfo | SyftError | None: + def status(self, project: Project) -> RequestStatus: """Returns the status of the request. Args: project (Project): Project object to check the status Returns: - str: Status of the request. + RequestStatus: Status of the request. During Request status calculation, we do not allow multiple responses """ - responses: list[ProjectEvent] = project.get_children(self) + responses: list[ProjectRequestResponse] = project.get_children(self) if len(responses) == 0: - return SyftInfo( - "No one has responded to the request yet. Kindly recheck later 🙂" + return RequestStatus.PENDING + + # Get the last response for the request + # That is the final state of the request + last_response = responses[-1] + return last_response.response + + +@serializable() +class ProjectAssetTransfer(ProjectEventAddObject): + __canonical_name__ = "ProjectAssetTransfer" + __version__ = SYFT_OBJECT_VERSION_1 + + asset_id: UID + asset_hash: str + asset_name: str + server_identity: ServerIdentity + code_id: UID # The code for which the asset is being transferred + + def get_event_details(self) -> str: + res = f"Asset ID: {get_copy_id_button_html(self.asset_id)}
" + res += f"Asset Name: {sanitize_html(self.asset_name)}
" + res += f"Asset Hash: {self.asset_hash}
" + res += f"name={sanitize_html(self.server_identity.server_name)} - id={get_copy_id_button_html(self.server_identity.server_id)} " + res += f"- 🔑={get_copy_id_button_html(self.server_identity.verify_key)}" + return res + + +@serializable() +class ProjectAttestationReport(ProjectEventAddObject): + __canonical_name__ = "ProjectAttestationReport" + __version__ = SYFT_OBJECT_VERSION_1 + + cpu_report: str | SyftError + gpu_report: str | SyftError + enclave_url: ServerURL + + def get_event_details(self) -> str: + cpu_status = "✅" if isinstance(self.cpu_report, str) else "❌" + gpu_status = "✅" if isinstance(self.gpu_report, str) else "❌" + res = f"CPU Attestation: {cpu_status}
" + res += f"GPU Attestation: {gpu_status}
" + res += f"Enclave URL: {self.enclave_url}" + return res + + +@serializable() +class ProjectExecutionStart(ProjectEventAddObject): + __canonical_name__ = "ProjectExecutionStart" + __version__ = SYFT_OBJECT_VERSION_1 + + server_identity: ServerIdentity # the server which starts the execution + code_id: UID # The code for which the execution is started + + def get_event_details(self) -> str: + res = f"Code ID: {get_copy_id_button_html(self.code_id)}
" + res += f"name={sanitize_html(self.server_identity.server_name)} - id={get_copy_id_button_html(self.server_identity.server_id)} " + res += f"- 🔑={get_copy_id_button_html(self.server_identity.verify_key)}" + return res + + +@serializable() +class ProjectEnclaveOutput(ProjectEventAddObject): + __canonical_name__ = "ProjectEnclaveOutput" + __version__ = SYFT_OBJECT_VERSION_1 + + server_identity: ServerIdentity # the server which downloads the result + output: Any + code_id: UID + + def get_event_details(self) -> str: + res = f"Code ID: {get_copy_id_button_html(self.code_id)}
" + res += f"name={sanitize_html(self.server_identity.server_name)} - id={get_copy_id_button_html(self.server_identity.server_id)} " + res += f"- 🔑={get_copy_id_button_html(self.server_identity.verify_key)}" + return res + + +@serializable() +class ProjectCode(ProjectEventAddObject): + __canonical_name__ = "ProjectCode" + __version__ = SYFT_OBJECT_VERSION_1 + + code: SubmitUserCode + allowed_sub_types: list[type] = [ProjectRequest] + + # TODO: Streamline get_event_details, we're always building them "by hand". + def get_event_details(self) -> str: + res = f"Submitted Code: {sanitize_html(self.code.func_name)}
" + res += f"ID: {get_copy_id_button_html(self.code.id)}
" + res += f"Hash: {self.code.get_code_hash()}
" + res += "Servers:
" + input_owner_server_identities: list[ServerIdentity] = ( + [] + if self.code.input_policy_init_kwargs is None + else list(self.code.input_policy_init_kwargs.keys()) + ) + + for server_identity in input_owner_server_identities: + res += f"name={sanitize_html(server_identity.server_name)} - id={get_copy_id_button_html(server_identity.server_id)} " + res += f"- 🔑={get_copy_id_button_html(server_identity.verify_key)}
" + return res + + def _ipython_display_(self) -> None: + code_block = as_markdown_python_code(self.code.code) + code_block = sanitize_html(code_block) + + def server_identity_html(server_identity: ServerIdentity) -> str: + return ( + f"ServerIdentity" + f" name={server_identity.server_name}," + f" id={get_copy_id_button_html(server_identity.server_id)}," + f" key={str(server_identity.verify_key)[0:8]}" + ) + + def set_policy_assets(policy_kwargs: Any) -> list[str]: + if not isinstance(policy_kwargs, dict): + return [] + + assets_strs = [] + + for server_identity, policy_assets in policy_kwargs.items(): + if isinstance(policy_assets, dict): + for asset_key, asset_value in policy_assets.items(): + assets_strs.append( + f"
  • Asset '{asset_key}'" + f" id={CopyIDButton(copy_text=str(asset_value), max_width=60).to_html()}" + f" on {server_identity_html(server_identity)}
    • " + ) + else: + assets_strs.append( + f"
  • Asset '{repr(policy_assets)}' on {server_identity_html(server_identity)}
    • " + ) + return assets_strs + + input_assets_list_items = set_policy_assets(self.code.input_policy_init_kwargs) + + provider = ( + self.code.runtime_policy_init_kwargs.get("provider") + if self.code.runtime_policy_init_kwargs + else None + ) + + if isinstance(provider, EnclaveInstance): + provider_list_item = ( + "
  • Enclave" + f" name={provider.name}" + f" id={CopyIDButton(copy_text=str(provider.id), max_width=60).to_html()}" + f" status={str(provider.status)}" + "
    • " + ) + elif provider is None: + provider_list_item = "
  • None
    • " + else: + provider_list_item = f"
  • id={CopyIDButton(copy_text=str(provider.id), max_width=60).to_html()}
    • " + + def extract_class_name(class_str: str) -> str: + if class_str.startswith(""): + return class_str.split(".")[-1][:-2] + + return "None" + + input_policy_type_str = extract_class_name(str(self.code.input_policy_type)) + output_policy_type_str = extract_class_name(str(self.code.output_policy_type)) + runtime_policy_type_str = extract_class_name(str(self.code.runtime_policy_type)) + + input_assets_list_items_str = "".join(input_assets_list_items) + input_policy_assets_str = ( + f"
      Input policy assets: {input_assets_list_items_str}
    " + if input_assets_list_items + else "" + ) + + html = f""" +

    Project Code

    + + Event ID: {CopyIDButton(copy_text=str(self.id), max_width=60).to_html()}
    + Code Hash: {self.code.get_code_hash()}
    + Project ID: {CopyIDButton(copy_text=str(self.project_id), max_width=60).to_html()}
    + Created at: {self.timestamp} +     + +

    Code:

    +

    + Function name: {self.code.func_name}
    + Input policy: {input_policy_type_str}
    + {input_policy_assets_str} + Output policy: {output_policy_type_str}
    + Runtime policy: {runtime_policy_type_str} + {f"

      Provider: {provider_list_item}
    " if provider else ""} +

    + """ + html = sanitize_html(html) + + display(HTML(html), Markdown(code_block)) + + def aggregate_final_status( + self, status_list: list[UserCodeStatus] + ) -> UserCodeStatus: + if UserCodeStatus.DENIED in status_list: + return UserCodeStatus.DENIED + elif UserCodeStatus.PENDING in status_list: + return UserCodeStatus.PENDING + else: + return UserCodeStatus.APPROVED + + def get_code_status_for_server( + self, server_uid: UID, project: Project + ) -> UserCodeStatus: + code_status = UserCodeStatus.PENDING + request_events: list[ProjectRequest] = project.get_children(self) + + # We follow a very simple heuristic to calculate the status of the code + # Get the last request submitted for this code on that server_uid + # If the last response for the request is approved/denied,then the code status is approved/denied + # if there is no response for the request, then the code status is pending + # This is mainly until , we define all the request semantics in the CodeBase. + code_status = UserCodeStatus.PENDING + for request_event in request_events[::-1]: + if request_event.linked_request.server_uid == server_uid: + request_status = request_event.status(project) + if request_status is RequestStatus.APPROVED: + code_status = UserCodeStatus.APPROVED + break + elif request_status is RequestStatus.REJECTED: + code_status = UserCodeStatus.DENIED + break + + return code_status + + def status( + self, project: Project, verbose: bool = False, verbose_return: bool = False + ) -> UserCodeStatus | dict[ServerIdentity | str, UserCodeStatus]: + init_kwargs = self.code.input_policy_init_kwargs or {} + input_owner_server_identities = init_kwargs.keys() + if len(input_owner_server_identities) == 0: + # TODO: add the ability to calculate status for empty input policies. + raise NotImplementedError("This feature is not implemented yet") + + code_status = {} + for server_identity in input_owner_server_identities: + code_status[server_identity] = self.get_code_status_for_server( + server_uid=server_identity.server_id, project=project + ) + + final_status = self.aggregate_final_status(list(code_status.values())) + + if verbose: + for server_identity, status in code_status.items(): + print(f"{server_identity.__repr__()}: {status}") + print(f"\nFinal Status: {final_status}") + + if verbose_return: + return {**code_status, "final_status": final_status} + + return final_status + + @property + def is_enclave_code(self) -> bool: + return bool( + self.code.runtime_policy_init_kwargs + and isinstance( + self.code.runtime_policy_init_kwargs.get("provider"), EnclaveInstance ) - elif len(responses) > 1: + ) + + def setup_enclave(self) -> SyftSuccess | SyftError: + if not self.is_enclave_code: return SyftError( - message="The Request Contains more than one Response" - "which is currently not possible" - "The request should contain only one response" - "Kindly re-submit a new request" - "The Syft Team is working on this issue to handle multiple responses" + message="This method is only supported for codes with Enclave runtime provider." ) - response = responses[0] - if not isinstance(response, ProjectRequestResponse): - return SyftError( # type: ignore[unreachable] - message=f"Response : {type(response)} is not of type ProjectRequestResponse" + runtime_policy_init_kwargs = self.code.runtime_policy_init_kwargs or {} + provider = cast(EnclaveInstance, runtime_policy_init_kwargs.get("provider")) + owner_server_id = provider.syft_server_location + + # TODO use server_uid, verify_key instead as there could be multiple logged-in users to the same client + owner_client = SyftClientSessionCache.get_client_for_server_uid(owner_server_id) + if not owner_client: + raise SyftException( + f"Can't access Syft client. You must login to {self.syft_server_location}" + ) + return owner_client.api.services.enclave.request_enclave( + user_code_id=self.code.id + ) + + def request_asset_transfer( + self, mock_report: bool = False + ) -> SyftSuccess | SyftError: + if not self.is_enclave_code: + return SyftError( + message="This method is only supported for codes with Enclave runtime provider." + ) + clients = set() + + if not self.code.input_owner_server_uids: + return SyftError( + message="No input assets owners found. Please check the code input policy." + ) + + for server_id in self.code.input_owner_server_uids: + client = SyftClientSessionCache.get_client_for_server_uid(server_id) + if not client: + raise SyftException( + f"Can't access Syft client. You must login to {server_id}" + ) + clients.add(client) + for client in clients: + assets_transferred = client.api.services.enclave.request_assets_upload( + user_code_id=self.code.id, mock_report=mock_report + ) + if isinstance(assets_transferred, SyftError): + raise SyftException(assets_transferred.message) + print(assets_transferred.message) + return SyftSuccess(message="All assets transferred to the Enclave successfully") + + def request_execution(self) -> Any: + if not self.is_enclave_code: + return SyftError( + message="This method is only supported for codes with Enclave runtime provider." + ) + clients = set() + + if not self.code.input_owner_server_uids: + return SyftError( + message="No input assets owners found. Please check the code input policy." + ) + + for server_id in self.code.input_owner_server_uids: + client = SyftClientSessionCache.get_client_for_server_uid(server_id) + if not client: + raise SyftException( + f"Can't access Syft client. You must login to {server_id}" + ) + clients.add(client) + result_parts = [] + for client in clients: + result = client.api.services.enclave.request_code_execution( + user_code_id=self.code.id + ) + if isinstance(result, SyftError): + return SyftError(message=f"Enclave execution failure: {result.message}") + result_parts.append(result) + return result_parts[0] + + def get_result(self) -> Any: + # Internally calling request_execution to get the result as it is idempotent + return self.request_execution() + + def orchestrate_enclave_execution(self) -> Any: + self.setup_enclave() + self.request_asset_transfer() + return self.request_execution() + + def view_attestation_report( + self, + attestation_type: AttestationType | str = AttestationType.CPU, + return_report: bool = False, + mock_report: bool = False, + ) -> dict | None: + if not self.is_enclave_code: + return SyftError( + message="This method is only supported for codes with Enclave runtime provider." + ) + if isinstance(attestation_type, str): + try: + attestation_type = AttestationType(attestation_type) + except ValueError: + all_attestation_types = human_friendly_join( + [e.value for e in AttestationType] + ) + return SyftError( + message=f"Invalid attestation type. Accepted values are {all_attestation_types}." + ) + runtime_policy_init_kwargs = self.code.runtime_policy_init_kwargs or {} + provider = cast(EnclaveInstance, runtime_policy_init_kwargs.get("provider")) + print("Performing remote attestation", flush=True) + machine_type = ( + "AMD SEV-SNP CPU" + if attestation_type == AttestationType.CPU + else "NVIDIA H100 GPU" + ) + + mock_report_prefix = "🛑 Mock" if mock_report else "" + print( + f"⏳ Retrieving {mock_report_prefix} attestation token from {machine_type}" + + f"Enclave at {provider.route}...", + flush=True, + ) + client = provider.get_guest_client() + raw_jwt_report = ( + client.api.services.attestation.get_cpu_attestation( + raw_token=True, mock_report=mock_report ) + if attestation_type == AttestationType.CPU + else client.api.services.attestation.get_gpu_attestation( + raw_token=True, mock_report=mock_report + ) + ) + if isinstance(raw_jwt_report, SyftError): + return raw_jwt_report + print( + f"🔐 Got encrypted attestation report of {len(raw_jwt_report)} bytes", + flush=True, + ) + print( + f"🔓 Decrypting attestation report using JWK certificates at {attestation_type.jwks_url}", + flush=True, + ) - print("Request Status : ", "Approved" if response.response else "Denied") + # If Mock Report is enabled, we don't need to verify the expiration + report = verify_attestation_report( + token=raw_jwt_report, + attestation_type=attestation_type, + verify_expiration=False if mock_report else True, + ) + if report.is_err(): + print( + f"❌ Attestation report verification failed. {report.err()}", flush=True + ) + report = report.ok() + print("🔍 Verifying attestation report...", flush=True) - return None + attestation_report: CPUAttestationReport | GPUAttestationReport + if attestation_type == AttestationType.CPU: + attestation_report = CPUAttestationReport(report) + else: + attestation_report = GPUAttestationReport(report) + summary = attestation_report.generate_summary() + + print(summary, flush=True) + + print("✅ Attestation report verified successfully.", flush=True) + if attestation_report.is_secure(): + print("✅ Syft Enclave is currently Secure.", flush=True) + else: + print("❌ Syft Enclave is currently Insecure.", flush=True) + + output = widgets.Output() + + def display_report(_: widgets.Button) -> None: + with output: + output.clear_output() + display(JSON(report)) + + button = widgets.Button(description="View full report") + button.on_click(display_report) + display(button) + display(output) + return report if return_report else None def poll_creation_wizard() -> tuple[str, list[str]]: @@ -618,7 +1127,7 @@ def __hash__(self) -> int: def add_code_request_to_project( project: ProjectSubmit | Project, code: SubmitUserCode, - client: SyftClient | Any, + clients: list[SyftClient] | Any, reason: str | None = None, ) -> SyftError | SyftSuccess: # TODO: fix the mypy issue @@ -627,27 +1136,44 @@ def add_code_request_to_project( message=f"Currently we are only support creating requests for SubmitUserCode: {type(code)}" ) - if not isinstance(client, SyftClient): - return SyftError(message="Client should be a valid SyftClient") + # Create a global ID for the Code to share among datasite servers + code_id = UID() + code.id = code_id + + # Add Project UID to the code + code.project_id = project.id + + if not isinstance(clients, Iterable): + clients = [clients] + + # TODO: can we remove clients in code submission? + if not all(isinstance(client, SyftClient) for client in clients): + return SyftError(message=f"Clients should be of type SyftClient: {clients}") if reason is None: reason = f"Code Request for Project: {project.name} has been submitted by {project.created_by}" - submitted_req = client.api.services.code.request_code_execution( - code=code, reason=reason - ) - if isinstance(submitted_req, SyftError): - return submitted_req - - request_event = ProjectRequest(linked_request=submitted_req) + # TODO: Think more about different ID in + # the datasite of project + # Project Code Event ID vs User Code ID. + code_event = ProjectCode(id=code_id, code=code) if isinstance(project, ProjectSubmit) and project.bootstrap_events is not None: - project.bootstrap_events.append(request_event) + project.bootstrap_events.append(code_event) else: - result = project.add_event(request_event) + result = project.add_event(code_event) if isinstance(result, SyftError): return result + # TODO: Modify request to be created at server side. + for client in clients: + submitted_req = client.api.services.code.request_code_execution( + code=code, reason=reason + ) + # TODO: Do we need to rollback the request if one of the requests fails? + if isinstance(submitted_req, SyftError): + return submitted_req + return SyftSuccess( message=f"Code request for '{code.func_name}' successfully added to '{project.name}' Project. " f"To see code requests by a client, run `[your_client].code`" @@ -921,22 +1447,22 @@ def get_events( def create_code_request( self, obj: SubmitUserCode, - client: SyftClient | None = None, + clients: SyftClient | None = None, reason: str | None = None, ) -> SyftSuccess | SyftError: - if client is None: + if clients is None: leader_client = self.get_leader_client(self.user_signing_key) res = add_code_request_to_project( project=self, code=obj, - client=leader_client, + clients=[leader_client], reason=reason, ) return res return add_code_request_to_project( project=self, code=obj, - client=client, + clients=clients, reason=reason, ) @@ -974,6 +1500,112 @@ def send_message(self, message: str) -> SyftSuccess | SyftError: return SyftSuccess(message="Message sent successfully") return result + def add_asset_transfer( + self, asset_id: UID, asset_name: str, asset_hash: str, code_id: UID + ) -> SyftSuccess | SyftError: + code = self.get_events(ids=code_id) + if len(code) == 0: + return SyftError(message=f"Code id: {code_id} not found") + code = code[0] + + asset_server_identity = None + for server_identity, assets in code.code.input_policy_init_kwargs.items(): + for code_asset_id in assets.values(): + if code_asset_id == asset_id: + asset_server_identity = server_identity + break + if not asset_server_identity: + return SyftError(message=f"Asset id: {asset_id} not found in the code") + + asset_transfer_event = ProjectAssetTransfer( + asset_id=asset_id, + asset_name=asset_name, + asset_hash=asset_hash, + server_identity=asset_server_identity, + code_id=code_id, + ) + + # TODO: Add validation for asset transfer event, check if the is datasite can transfer the asset. + result = self.add_event(asset_transfer_event) + if isinstance(result, SyftSuccess): + return SyftSuccess(message="Asset transfer added successfully") + return result + + def add_enclave_attestation_report( + self, cpu_report: str | SyftError, gpu_report: str | SyftError, enclave_url: str + ) -> SyftSuccess | SyftError: + enclave_report_event = ProjectAttestationReport( + cpu_report=cpu_report, gpu_report=gpu_report, enclave_url=enclave_url + ) + result = self.add_event(enclave_report_event) + if isinstance(result, SyftSuccess): + return SyftSuccess(message="Enclave attestation report added successfully") + return result + + def add_execution_start(self, code_id: UID) -> SyftSuccess | SyftError: + pre_execution_events = self.get_events(types=ProjectExecutionStart) + for event in pre_execution_events: + if event.code_id == code_id: + return SyftSuccess( + message=f"Execution already started for code id: {code_id}" + ) + + code = self.get_events(ids=code_id) + if len(code) == 0: + return SyftError(message=f"Code id: {code_id} not found") + code = code[0] + + execution_server_identity = ( + None # Server Identity of the current project object + ) + for server_identity, _ in code.code.input_policy_init_kwargs.items(): + if server_identity.verify_key == self.syft_client_verify_key: + execution_server_identity = server_identity + break + + if not execution_server_identity: + return SyftError(message="Server identity not found in code input policy") + + enclave_execution_start_event = ProjectExecutionStart( + server_identity=execution_server_identity, code_id=code_id + ) + + result = self.add_event(enclave_execution_start_event) + if isinstance(result, SyftSuccess): + return SyftSuccess(message="Execution event added to project") + return result + + def add_enclave_output(self, code_id: UID, output: Any) -> SyftSuccess | SyftError: + pre_output_events = self.get_events(types=ProjectEnclaveOutput) + for event in pre_output_events: + if event.server_identity.verify_key == self.syft_client_verify_key: + return SyftSuccess( + message=f"Enclave Output already added to code object: {code_id}" + ) + + code = self.get_events(ids=code_id) + if len(code) == 0: + return SyftError(message=f"Code id: {code_id} not found") + code = code[0] + + current_server_identity = None # Server Identity of the current project object + for server_identity, _ in code.code.input_policy_init_kwargs.items(): + if server_identity.verify_key == self.syft_client_verify_key: + current_server_identity = server_identity + break + + if not current_server_identity: + return SyftError(message="Server identity not found in code input policy") + + enclave_output_event = ProjectEnclaveOutput( + server_identity=current_server_identity, output=output, code_id=code_id + ) + + result = self.add_event(enclave_output_event) + if isinstance(result, SyftSuccess): + return SyftSuccess(message="Enclave Output Saved to Project") + return result + def reply_message( self, reply: str, @@ -1047,18 +1679,29 @@ def answer_poll( return SyftSuccess(message="Poll answered successfully") return result - def add_request( - self, - request: Request, - ) -> SyftSuccess | SyftError: + def add_request(self, request: Request, code_id: UID) -> SyftSuccess | SyftError: linked_request = LinkedObject.from_obj(request, server_uid=request.server_uid) - request_event = ProjectRequest(linked_request=linked_request) + request_event = ProjectRequest( + id=request.id, linked_request=linked_request, parent_event_id=code_id + ) result = self.add_event(request_event) if isinstance(result, SyftSuccess): return SyftSuccess(message="Request created successfully") return result + def add_request_response( + self, request_id: UID, response: RequestStatus + ) -> SyftSuccess | SyftError: + response_event = ProjectRequestResponse( + parent_event_id=request_id, response=response + ) + result = self.add_event(response_event) + + if isinstance(result, SyftSuccess): + return SyftSuccess(message="Response added successfully") + return result + # Since currently we do not have the notion of denying a request # Adding only approve request, which would later be used to approve or deny a request def approve_request( @@ -1129,9 +1772,16 @@ def sync(self, verbose: bool | None = True) -> SyftSuccess | SyftError: @property def requests(self) -> list[Request]: return [ - event.request for event in self.events if isinstance(event, ProjectRequest) + event.request + for event in self.events + if isinstance(event, ProjectRequest) + and self.syft_server_location == event.linked_request.server_uid ] + @property + def code(self) -> list[ProjectCode]: + return self.get_events(types=[ProjectCode]) + @property def pending_requests(self) -> int: return sum( @@ -1254,12 +1904,12 @@ def to_server_identity(val: SyftClient | ServerIdentity) -> ServerIdentity: ) def create_code_request( - self, obj: SubmitUserCode, client: SyftClient, reason: str | None = None + self, obj: SubmitUserCode, clients: SyftClient, reason: str | None = None ) -> SyftError | SyftSuccess: return add_code_request_to_project( project=self, code=obj, - client=client, + clients=clients, reason=reason, ) @@ -1273,14 +1923,17 @@ def send(self, return_all_projects: bool = False) -> Project | list[Project]: # Currently we are assuming that the first member is the leader # This would be changed in our future leaderless approach leader = self.clients[0] - followers = self.clients[1:] try: + # TODO: should we move this before initializing the project + # Check if all clients are reachable + self._connection_checks(self.clients) + # Check for DS role across all members self._pre_submit_checks(self.clients) - # Exchange route between leaders and followers - self._exchange_routes(leader, followers) + # Create Leader Server Route + self.leader_server_route = connection_to_route(leader.connection) # create project for each server projects_map = self._create_projects(self.clients) @@ -1307,19 +1960,13 @@ def _pre_submit_checks(self, clients: list[SyftClient]) -> bool: return True - def _exchange_routes(self, leader: SyftClient, followers: list[SyftClient]) -> None: - # Since we are implementing a leader based system - # To be able to optimize exchanging routes. - # We require only the leader to exchange routes with all the members - # Meaning if we could guarantee, that the leader server is able to reach the members - # the project events could be broadcasted to all the members - - for follower in followers: - result = leader.exchange_route(follower) - if isinstance(result, SyftError): - raise SyftException(result.message) - - self.leader_server_route = connection_to_route(leader.connection) + def _connection_checks(self, clients: list[SyftClient]) -> bool: + # Check if all clients are reachable + conn_res = check_route_reachability(clients) + if isinstance(conn_res, SyftError): + # TODO: add a convienient way to connect clients + raise SyftException(conn_res.message) + return True def _create_projects(self, clients: list[SyftClient]) -> dict[SyftClient, Project]: projects: dict[SyftClient, Project] = {} diff --git a/packages/syft/src/syft/service/project/project_service.py b/packages/syft/src/syft/service/project/project_service.py index 0da9d043e18..115e6640ea5 100644 --- a/packages/syft/src/syft/service/project/project_service.py +++ b/packages/syft/src/syft/service/project/project_service.py @@ -344,7 +344,8 @@ def get_by_uid( if result.is_err(): return SyftError(message=str(result.err())) elif result.ok(): - return result.ok() + project = result.ok() + return self.add_signing_key_to_project(context, project) return SyftError(message=f'Project(id="{uid}") does not exist') def add_signing_key_to_project( diff --git a/packages/syft/src/syft/service/request/request.py b/packages/syft/src/syft/service/request/request.py index 3ec7c5ef184..287c9919b8b 100644 --- a/packages/syft/src/syft/service/request/request.py +++ b/packages/syft/src/syft/service/request/request.py @@ -87,6 +87,24 @@ class Change(SyftObject): def change_object_is_type(self, type_: type) -> bool: return self.linked_obj is not None and type_ == self.linked_obj.object_type + # TODO: remove Any in argument by moving changes to a different file, + # this is done as changes and request have a catch 22 situation in order of the code. + # Runs a post hook after the change is created, applied, or undone + def post_create_hook( + self, context: ChangeContext, request: Any + ) -> SyftSuccess | SyftError | None: + pass + + def post_apply_hook( + self, context: ChangeContext, request: Any + ) -> SyftSuccess | SyftError | None: + pass + + def post_undo_hook( + self, context: ChangeContext, request: Any + ) -> SyftSuccess | SyftError | None: + pass + @serializable() class ChangeStatus(SyftObject): @@ -515,7 +533,7 @@ def _coll_repr_(self) -> dict[str, str | dict[str, str]]: return { "Description": self.html_description, "Requested By": "\n".join(user_data), - "Creation Time": str(self.request_time), + "Created at": str(self.request_time), "Status": status_badge, } @@ -694,6 +712,11 @@ def apply(self, context: AuthedServiceContext) -> Result[SyftSuccess, SyftError] self.save(context=context) return result + # Apply Post Apply Hook + apply_hook_res = change.post_apply_hook(context=context, request=self) + if isinstance(apply_hook_res, SyftError): + return apply_hook_res + # If no error, then change successfully applied. change_status.applied = True self.history.append(change_status) @@ -723,6 +746,11 @@ def undo(self, context: AuthedServiceContext) -> Result[SyftSuccess, SyftError]: self.save(context=context) return result + # Apply Post Apply Hook + undo_hook_res = change.post_undo_hook(context=context, request=self) + if isinstance(undo_hook_res, SyftError): + return undo_hook_res + # If no error, then change successfully undone. change_status.applied = False self.history.append(change_status) @@ -1300,6 +1328,82 @@ def link(self) -> SyftObject | None: return self.linked_obj.resolve return None + def post_create_hook( + self, context: ChangeContext, request: Request + ) -> SyftSuccess | SyftError | None: + # relative + from ..project.project import Project + from ..project.project_service import ProjectService + + code = self.get_user_code(context) + + # Perform Post Create Hook only when the code is part of a project + if isinstance(code.project_id, UID): + project_service = context.server.get_service(ProjectService) + + root_context = context.as_root_context() + project_obj: Project = project_service.get_by_uid( + root_context, uid=code.project_id + ) + if isinstance(project_obj, SyftError): + return project_obj + + req_res = project_obj.add_request(request, code_id=code.id) + return req_res + return None + + def post_apply_hook( + self, context: ChangeContext, request: Request + ) -> SyftSuccess | SyftError | None: + # relative + from ..project.project import Project + from ..project.project_service import ProjectService + + code = self.get_user_code(context) + + # Perform Post Apply Hook only when the code is part of a project + if isinstance(code.project_id, UID): + project_service = context.server.get_service(ProjectService) + + root_context = context.as_root_context() + project_obj: Project = project_service.get_by_uid( + root_context, uid=code.project_id + ) + if isinstance(project_obj, SyftError): + return project_obj + + req_res = project_obj.add_request_response( + request_id=request.id, response=RequestStatus.APPROVED + ) + return req_res + return None + + def post_undo_hook( + self, context: ChangeContext, request: Request + ) -> SyftSuccess | SyftError | None: + # relative + from ..project.project import Project + from ..project.project_service import ProjectService + + code = self.get_user_code(context) + + # Perform Post Apply Hook only when the code is part of a project + if isinstance(code.project_id, UID): + project_service = context.server.get_service(ProjectService) + + root_context = context.as_root_context() + project_obj: Project = project_service.get_by_uid( + root_context, uid=code.project_id + ) + if isinstance(project_obj, SyftError): + return project_obj + + req_res = project_obj.add_request_response( + request_id=request.id, response=RequestStatus.REJECTED + ) + return req_res + return None + @serializable() class SyncedUserCodeStatusChange(UserCodeStatusChange): diff --git a/packages/syft/src/syft/service/request/request_service.py b/packages/syft/src/syft/service/request/request_service.py index 9adb82d283f..d24ed8231e9 100644 --- a/packages/syft/src/syft/service/request/request_service.py +++ b/packages/syft/src/syft/service/request/request_service.py @@ -69,6 +69,16 @@ def submit( ) if result.is_ok(): request = result.ok() + + # Apply Post Create Hooks to the request + for change in request.changes: + create_hook_res = change.post_create_hook( + context=context, request=request + ) + if isinstance(create_hook_res, SyftError): + return create_hook_res + + # Creating Notification link = LinkedObject.with_context(request, context=context) admin_verify_key = context.server.get_service_method( @@ -76,6 +86,7 @@ def submit( ) root_verify_key = admin_verify_key() + if send_message: subject_msg = f"Result to request {str(request.id)[:4]}...{str(request.id)[-3:]}\ has been successfully deposited." @@ -89,12 +100,17 @@ def submit( ) method = context.server.get_service_method(NotificationService.send) result = method(context=context, notification=message) + + # do we override the return here? if isinstance(result, Notification): return request else: - return SyftError( - message=f"Failed to send notification: {result.err()}" - ) + if isinstance(result, SyftError): + return result + else: + return SyftError( + message=f"Failed to send notification: {str(result)}" + ) return request diff --git a/packages/syft/src/syft/service/response.py b/packages/syft/src/syft/service/response.py index ebecf9e2fcb..0c9e51e6f3e 100644 --- a/packages/syft/src/syft/service/response.py +++ b/packages/syft/src/syft/service/response.py @@ -68,8 +68,8 @@ def _repr_html_(self) -> str: return ( f'
    ' f"{type(self).__name__}: " - f'
    '
-            f"{sanitize_html(self.message)}

    " + f'' + f"{sanitize_html(self.message)}
    " ) diff --git a/packages/syft/src/syft/service/service.py b/packages/syft/src/syft/service/service.py index 76a61689eaa..76e79821458 100644 --- a/packages/syft/src/syft/service/service.py +++ b/packages/syft/src/syft/service/service.py @@ -498,5 +498,9 @@ def from_api_or_context( ) return partial(service_method, server_context) else: - logger.error("Could not get method from api or context") + logger.error( + f"Could not get method: {func_or_path} from api or context" + + f"for server id: {syft_server_location} and " + + f"user verify key: {syft_client_verify_key}" + ) return None diff --git a/packages/syft/src/syft/store/blob_storage/__init__.py b/packages/syft/src/syft/store/blob_storage/__init__.py index 50f3329ecc0..94af62cadfe 100644 --- a/packages/syft/src/syft/store/blob_storage/__init__.py +++ b/packages/syft/src/syft/store/blob_storage/__init__.py @@ -89,12 +89,38 @@ class BlobRetrieval(SyftObject): file_size: int | None = None +# This is short term solution to improve the performance for +# testing, as the pydantic v2 is slow for instance checks for +# the method attach_attributes_to_syft_object +# ref: https://github.com/pydantic/pydantic/issues/9458 +# which greatly slows object retrieval from the store. + + @serializable() -class SyftObjectRetrieval(BlobRetrieval): +class SyftObjectRetrieval: __canonical_name__ = "SyftObjectRetrieval" __version__ = SYFT_OBJECT_VERSION_1 syft_object: bytes + type_: type | None = None + file_name: str + syft_blob_storage_entry_id: UID | None = None + file_size: int | None = None + + # init method to take in all class attributes + def __init__( + self, + syft_object: bytes, + file_name: str, + type_: type | None = None, + syft_blob_storage_entry_id: UID | None = None, + file_size: int | None = None, + ) -> None: + self.syft_object = syft_object + self.file_name = file_name + self.type_ = type_ + self.syft_blob_storage_entry_id = syft_blob_storage_entry_id + self.file_size = file_size def _read_data( self, stream: bool = False, _deserialize: bool = True, **kwargs: Any diff --git a/packages/syft/src/syft/store/blob_storage/on_disk.py b/packages/syft/src/syft/store/blob_storage/on_disk.py index 199e6cc36cf..e612d5d98b6 100644 --- a/packages/syft/src/syft/store/blob_storage/on_disk.py +++ b/packages/syft/src/syft/store/blob_storage/on_disk.py @@ -32,14 +32,28 @@ def write(self, data: BytesIO) -> SyftSuccess | SyftError: # relative from ...service.service import from_api_or_context - write_to_disk_method = from_api_or_context( - func_or_path="blob_storage.write_to_disk", + get_by_uid_method = from_api_or_context( + func_or_path="blob_storage.get_by_uid", syft_server_location=self.syft_server_location, syft_client_verify_key=self.syft_client_verify_key, ) - if write_to_disk_method is None: - return SyftError(message="write_to_disk_method is None") - return write_to_disk_method(data=data.read(), uid=self.blob_storage_entry_id) + if get_by_uid_method is None: + return SyftError(message="get_by_uid_method is None") + + obj = get_by_uid_method(uid=self.blob_storage_entry_id) + if isinstance(obj, SyftError): + return obj + if obj is None: + return SyftError( + message=f"No blob storage entry exists for uid: {self.blob_storage_entry_id}, " + "or you have no permissions to read it" + ) + + try: + Path(obj.location.path).write_bytes(data.read()) + return SyftSuccess(message="File successfully saved.") + except Exception as e: + return SyftError(message=f"Failed to write object to disk: {e}") class OnDiskBlobStorageConnection(BlobStorageConnection): @@ -58,7 +72,7 @@ def read( self, fp: SecureFilePathLocation, type_: type | None, **kwargs: Any ) -> BlobRetrieval: file_path = self._base_directory / fp.path - return SyftObjectRetrieval( + return SyftObjectRetrieval( # type: ignore syft_object=file_path.read_bytes(), file_name=file_path.name, type_=type_, diff --git a/packages/syft/src/syft/store/blob_storage/seaweedfs.py b/packages/syft/src/syft/store/blob_storage/seaweedfs.py index f3215938559..550952f441b 100644 --- a/packages/syft/src/syft/store/blob_storage/seaweedfs.py +++ b/packages/syft/src/syft/store/blob_storage/seaweedfs.py @@ -40,7 +40,6 @@ from ...types.server_url import ServerURL from ...types.syft_object import SYFT_OBJECT_VERSION_1 from ...types.uid import UID -from ...util.constants import DEFAULT_TIMEOUT logger = logging.getLogger(__name__) @@ -48,6 +47,7 @@ WRITE_EXPIRATION_TIME = 900 # seconds DEFAULT_FILE_PART_SIZE = 1024**3 # 1GB DEFAULT_UPLOAD_CHUNK_SIZE = 1024 * 800 # 800KB +SEAWEEDFS_UPLOAD_TIMEOUT = 600 # 10 minutes @serializable() @@ -84,8 +84,9 @@ def write(self, data: BytesIO) -> SyftSuccess | SyftError: with tqdm( total=total_iterations, - desc=f"Uploading progress", # noqa + desc=f"Uploading to Blob Storage", # noqa colour="green", + position=0, ) as pbar: for part_no, url in enumerate( self.urls, @@ -149,7 +150,7 @@ def add_chunks_to_queue( response = requests.put( url=str(blob_url), data=gen.async_generator(chunk_size), - timeout=DEFAULT_TIMEOUT, + timeout=SEAWEEDFS_UPLOAD_TIMEOUT, stream=True, ) diff --git a/packages/syft/src/syft/types/blob_storage.py b/packages/syft/src/syft/types/blob_storage.py index fb8e854ccfe..d52e8982e0d 100644 --- a/packages/syft/src/syft/types/blob_storage.py +++ b/packages/syft/src/syft/types/blob_storage.py @@ -27,6 +27,7 @@ from ..server.credentials import SyftVerifyKey from ..service.action.action_object import ActionObject from ..service.action.action_object import ActionObjectPointer +from ..service.action.action_object import ActionObjectV1 from ..service.action.action_object import BASE_PASSTHROUGH_ATTRS from ..service.action.action_types import action_types from ..service.response import SyftError @@ -37,6 +38,7 @@ from ..types.transforms import transform from .datetime import DateTime from .syft_object import SYFT_OBJECT_VERSION_1 +from .syft_object import SYFT_OBJECT_VERSION_2 from .syft_object import SyftObject from .uid import UID @@ -192,7 +194,7 @@ class BlobFileObjectPointer(ActionObjectPointer): @serializable() -class BlobFileObject(ActionObject): +class BlobFileObjectV1(ActionObjectV1): __canonical_name__ = "BlobFileOBject" __version__ = SYFT_OBJECT_VERSION_1 @@ -201,6 +203,16 @@ class BlobFileObject(ActionObject): syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS +@serializable() +class BlobFileObject(ActionObject): + __canonical_name__ = "BlobFileOBject" + __version__ = SYFT_OBJECT_VERSION_2 + + syft_internal_type: ClassVar[type[Any]] = BlobFile + syft_pointer_type: ClassVar[type[ActionObjectPointer]] = BlobFileObjectPointer + syft_passthrough_attrs: list[str] = BASE_PASSTHROUGH_ATTRS + + @serializable() class SecureFilePathLocation(SyftObject): __canonical_name__ = "SecureFilePathLocation" diff --git a/packages/syft/src/syft/types/file.py b/packages/syft/src/syft/types/file.py new file mode 100644 index 00000000000..fa9d9440721 --- /dev/null +++ b/packages/syft/src/syft/types/file.py @@ -0,0 +1,177 @@ +# future +from __future__ import annotations + +# stdlib +import mimetypes +import os +from pathlib import Path +import tempfile + +# relative +from ..serde.serializable import serializable +from ..service.response import SyftError +from ..service.response import SyftSuccess +from ..types.syft_object import SYFT_OBJECT_VERSION_1 +from ..types.syft_object import SyftObject + +# extra mime types not in mimetypes.types_map +mime_types = { + ".msgpack": "application/msgpack", + ".yml": "application/yaml", + ".yaml": "application/yaml", + ".safetensor": "application/octet-stream", +} + + +def get_mimetype(filename: str, path: str) -> str: + try: + mimetype = mimetypes.guess_type(path)[0] + if mimetype is not None: + return mimetype + + extension_parts = filename.split(".") + if len(extension_parts) > 1: + extension = f".{extension_parts[-1]}" + if extension in mime_types: + return mime_types[extension] + except Exception as e: + print(f"failed to get mime type. {e}") + return "application/octet-stream" + + +@serializable() +class SyftFile(SyftObject): + __canonical_name__ = "SyftFile" + __version__ = SYFT_OBJECT_VERSION_1 + filename: str + data: bytes + size_bytes: int + mimetype: str + + __repr_attrs__ = ["filename", "mimetype", "size_bytes"] + + def head(self, length: int = 200) -> str: + return self.decode(length=length) + + def decode(self, length: int = -1) -> str: + output = "" + try: + if length < 0: + length = self.size_bytes + slice_size = min(length, self.size_bytes) + + output = self.data[:slice_size].decode("utf-8") + except Exception: # nosec + print("Failed to slice bytes") + if length < self.size_bytes: + output += "\n..." + return output + + def write_file(self, path: str) -> SyftSuccess | SyftError: + try: + full_path = f"{path}/{self.filename}" + if os.path.exists(full_path): + return SyftSuccess(message=f"File already exists: {full_path}") + with open(full_path, "wb") as f: + f.write(self.data) + return SyftSuccess(message=f"File saved: {full_path}") + except Exception as e: + return SyftError(message=f"Failed to write {type(self)} to {path}. {e}") + + @staticmethod + def from_string( + content: str, filename: str = "file.txt", mime_type: str | None = None + ) -> SyftFile | None: + data = content.encode("utf-8") + if mime_type is None: + mime_type = get_mimetype(filename, filename) + return SyftFile( + filename=filename, + size_bytes=len(data), + mimetype=mime_type, + data=data, + ) + + @staticmethod + def from_path(path: str) -> SyftFile | None: + abs_path = os.path.abspath(os.path.expanduser(path)) + if os.path.exists(abs_path): + try: + with open(abs_path, "rb") as f: + file_size = os.path.getsize(abs_path) + filename = os.path.basename(abs_path) + return SyftFile( + filename=filename, + size_bytes=file_size, + mimetype=get_mimetype(filename, abs_path), + data=f.read(), + ) + except Exception: + print(f"Failed to load: {path} as syft file") + return None + + +@serializable() +class SyftFolder(SyftObject): + __canonical_name__ = "SyftFolder" + __version__ = SYFT_OBJECT_VERSION_1 + files: list[SyftFile] + name: str + + @property + def size_bytes(self) -> int: + total_size = 0 + for syft_file in self.files: + total_size += syft_file.size_bytes + return total_size + + @property + def size_mb(self) -> float: + return self.size_bytes / 1024 / 1024 + + # method to write the folder in current directory + def write_folder_to_current_path(self) -> bool: + try: + path = Path(os.getcwd()) / self.name + os.makedirs(path, exist_ok=True) + for syft_file in self.files: + syft_file.write_file(path) + return True + except Exception: + return False + + @property + def model_folder(self) -> str: + # TODO: make sure filenames are sanitized and arent file paths + # TODO: this path should be unique to the user so you cant hijack another folder + path = Path(tempfile.gettempdir()) / self.name + os.makedirs(path, exist_ok=True) + for syft_file in self.files: + syft_file.write_file(path) + return str(path) + + @staticmethod + def from_dir(name: str, path: str, ignore_hidden: bool = True) -> SyftFolder: + syft_files = [] + abs_path = Path(os.path.abspath(os.path.expanduser(path))) + if not os.path.exists(abs_path): + raise Exception(f"{abs_path} does not exist") + + with os.scandir(abs_path) as entries: + for entry in entries: + if entry.is_file(): + if ignore_hidden and entry.name.startswith("."): + continue + try: + with open(entry.path, "rb") as f: + file_size = os.path.getsize(entry.path) + syft_file = SyftFile( + filename=entry.name, + size_bytes=file_size, + mimetype=get_mimetype(entry.name, entry.path), + data=f.read(), + ) + syft_files.append(syft_file) + except Exception: + print(f"Failed to load: {entry} as syft file") + return SyftFolder(name=name, files=syft_files) diff --git a/packages/syft/src/syft/types/server_url.py b/packages/syft/src/syft/types/server_url.py index c0bbab960a5..4a571d074af 100644 --- a/packages/syft/src/syft/types/server_url.py +++ b/packages/syft/src/syft/types/server_url.py @@ -93,6 +93,7 @@ def as_container_host(self, container_host: str | None = None) -> Self: "localhost", "host.docker.internal", "host.k3d.internal", + "0.0.0.0", ]: return self diff --git a/packages/syft/src/syft/util/misc_objs.py b/packages/syft/src/syft/util/misc_objs.py index 221396b8bb3..20e7928dc7f 100644 --- a/packages/syft/src/syft/util/misc_objs.py +++ b/packages/syft/src/syft/util/misc_objs.py @@ -1,6 +1,4 @@ # third party -from IPython.display import HTML -from IPython.display import display # relative from ..serde.serializable import serializable @@ -17,19 +15,6 @@ class MarkdownDescription(SyftObject): text: str def _repr_markdown_(self, wrap_as_python: bool = True, indent: int = 0) -> str: - style = """ - - """ - display(HTML(style)) return self.text diff --git a/packages/syft/src/syft/util/notebook_ui/components/tabulator_template.py b/packages/syft/src/syft/util/notebook_ui/components/tabulator_template.py index f00fed8694f..8499a89716f 100644 --- a/packages/syft/src/syft/util/notebook_ui/components/tabulator_template.py +++ b/packages/syft/src/syft/util/notebook_ui/components/tabulator_template.py @@ -35,6 +35,7 @@ def create_tabulator_columns( columns = [] row_header = {} + if TABLE_INDEX_KEY in column_names: row_header = { "field": TABLE_INDEX_KEY, @@ -79,6 +80,8 @@ def format_dict(data: Any) -> str: return Label(value=data["value"], label_class=data["type"]).to_html() if "clipboard" in data["type"]: return CopyButton(copy_text=data["value"]).to_html() + if "events" in data["type"]: + return data["value"] return sanitize_html(str(data)) diff --git a/packages/syft/src/syft/util/patch_ipython.py b/packages/syft/src/syft/util/patch_ipython.py index b5f16f512a9..7212c360a64 100644 --- a/packages/syft/src/syft/util/patch_ipython.py +++ b/packages/syft/src/syft/util/patch_ipython.py @@ -81,6 +81,7 @@ def display_sanitized_html(obj: SyftObject | DictTuple) -> str | None: matching_table = escaped_template.findall(html_str) matching_jobs = jobs_pattern.findall(html_str) template = "\n".join(matching_table + matching_jobs) + sanitized_str = escaped_template.sub("", html_str) sanitized_str = escaped_js_css.sub("", sanitized_str) sanitized_str = jobs_pattern.sub("", sanitized_str) diff --git a/packages/syft/src/syft/util/table.py b/packages/syft/src/syft/util/table.py index 8bfd88a4f58..542db9a9a47 100644 --- a/packages/syft/src/syft/util/table.py +++ b/packages/syft/src/syft/util/table.py @@ -240,6 +240,15 @@ def prepare_table_data( extra_fields = getattr(first_value, "__repr_attrs__", []) is_homogenous = len({type(x) for x in values}) == 1 + + # A quick hack to add type to project events table + # This is for single event type tables + # relative + from ..service.project.project import ProjectEvent + + if issubclass(type(first_value), ProjectEvent): + is_homogenous = False + if is_homogenous: sort_key = getattr(first_value, "__table_sort_attr__", None) or "created_at" cls_name = first_value.__class__.__name__ diff --git a/packages/syft/src/syft/util/util.py b/packages/syft/src/syft/util/util.py index 43620c4cab5..d3ebdc517ae 100644 --- a/packages/syft/src/syft/util/util.py +++ b/packages/syft/src/syft/util/util.py @@ -998,6 +998,41 @@ def get_latest_tag(registry: str, repo: str) -> str | None: return None +def human_friendly_join( + items: list[str], sep: str = ", ", last_sep: str = " and " +) -> str: + """Joins a list of strings into a single string with specified separators. + + This function concatenates the elements of a list into a single string. + Elements are separated by `sep`, except for the last two elements which + are separated by `last_sep`. + + Parameters: + items (list of str): The list of strings to join. + sep (str): The separator between all elements except the last two. Default is ", ". + last_sep (str): The separator between the last two elements. Default is " and ". + + Returns: + str: The concatenated string. + + Examples: + >>> custom_join(["a", "b", "c", "d"]) + 'a, b, c and d' + >>> custom_join(["a", "b"], sep="; ", last_sep=" or ") + 'a or b' + >>> custom_join(["a"]) + 'a' + >>> custom_join([]) + '' + """ + if not items: + return "" + elif len(items) == 1: + return items[0] + else: + return sep.join(items[:-1]) + last_sep + items[-1] + + def get_nb_secrets(defaults: dict | None = None) -> dict: if defaults is None: defaults = {} diff --git a/scripts/reset_k8s.sh b/scripts/reset_k8s.sh new file mode 100755 index 00000000000..5da8041d5a3 --- /dev/null +++ b/scripts/reset_k8s.sh @@ -0,0 +1,77 @@ +#!/bin/bash + +set -e + +# Default context to current if not provided +CONTEXT=${1:-$(kubectl config current-context)} +NAMESPACE=${2:-syft} + +echo "Resetting Kubernetes resources in context $CONTEXT and namespace $NAMESPACE" + +print_progress() { + echo -e "\033[1;32m[$(date +'%Y-%m-%d %H:%M:%S')] $1\033[0m" +} + +# Set the Kubernetes context +kubectl config use-context $CONTEXT + +# Function to reset a StatefulSet and delete its PVCs +reset_statefulset() { + local statefulset=$1 + local component=$2 + + print_progress "Scaling down $statefulset StatefulSet..." + kubectl scale statefulset $statefulset --replicas=0 -n $NAMESPACE + + print_progress "Deleting PVCs for $statefulset..." + local pvcs=$(kubectl get pvc -l app.kubernetes.io/component=$component -n $NAMESPACE -o jsonpath='{.items[*].metadata.name}') + for pvc in $pvcs; do + kubectl delete pvc $pvc -n $NAMESPACE + done + + print_progress "Scaling up $statefulset StatefulSet..." + kubectl scale statefulset $statefulset --replicas=1 -n $NAMESPACE + + print_progress "Waiting for $statefulset StatefulSet to be ready..." + kubectl rollout status statefulset $statefulset -n $NAMESPACE +} + +# Function to delete a StatefulSet +delete_statefulset() { + local statefulset=$1 + + print_progress "Deleting $statefulset StatefulSet..." + kubectl delete statefulset $statefulset -n $NAMESPACE + +# # Since Default Pool does not have any PVCs, we can skip this step +# print_progress "Deleting PVCs for $statefulset..." +# local pvcs=$(kubectl get pvc -l statefulset.kubernetes.io/pod-name=${statefulset}-0 -n $NAMESPACE -o jsonpath='{.items[*].metadata.name}') +# for pvc in $pvcs; do +# kubectl delete pvc $pvc -n $NAMESPACE +# done + + print_progress "Waiting for $statefulset StatefulSet to be fully deleted..." + kubectl wait --for=delete statefulset/$statefulset -n $NAMESPACE +} + +# Reset MongoDB StatefulSet +reset_statefulset "mongo" "mongo" & + +# Reset SeaweedFS StatefulSet +reset_statefulset "seaweedfs" "seaweedfs" & + +# Wait for MongoDB and SeaweedFS to be reset +wait + +# Delete default-pool StatefulSet +delete_statefulset "default-pool" + +# Restart Backend StatefulSet +print_progress "Restarting backend StatefulSet..." +kubectl scale statefulset backend --replicas=0 -n $NAMESPACE +kubectl scale statefulset backend --replicas=1 -n $NAMESPACE +print_progress "Waiting for backend StatefulSet to be ready..." +kubectl rollout status statefulset backend -n $NAMESPACE + + +print_progress "All operations completed successfully." diff --git a/tox.ini b/tox.ini index 81514895f97..3b454a914a5 100644 --- a/tox.ini +++ b/tox.ini @@ -935,11 +935,21 @@ passenv = HOME, USER setenv= CLUSTER_NAME = {env:CLUSTER_NAME:test-enclave-1} CLUSTER_HTTP_PORT={env:CLUSTER_HTTP_PORT:9083} - DEVSPACE_PROFILE=enclave + K3S_DOCKER_IMAGE={env:K3S_DOCKER_IMAGE:docker.io/rasswanth/k3s:v1.28.8-k3s1-cuda-12.2.0-base-ubuntu22.04} + CLUSTER_ARGS={env:CLUSTER_ARGS:--volume /sys/kernel/security:/sys/kernel/security --volume /dev/tpmrm0:/dev/tpmrm0} + DEVSPACE_PROFILE={env:DEVSPACE_PROFILE:enclave-cpu} allowlist_externals = tox + bash commands = - tox -e dev.k8s.start -- --volume /sys/kernel/security:/sys/kernel/security --volume /dev/tmprm0:/dev/tmprm0 + bash -c "echo k3S_DOCKER_IMAGE=$K3S_DOCKER_IMAGE GPU_ENABLED=$GPU_ENABLED" + bash -c "if [ $DEVSPACE_PROFILE == 'enclave-gpu' ]; then \ + echo 'Starting cluster with GPU support'; \ + tox -e dev.k8s.start -- $CLUSTER_ARGS --image=$K3S_DOCKER_IMAGE --gpus=all; \ + else \ + echo 'Starting cluster with CPU support'; \ + tox -e dev.k8s.start -- $CLUSTER_ARGS; \ + fi" tox -e dev.k8s.{posargs:deploy} [testenv:dev.k8s.destroy]