prefab 0.4.6__tar.gz → 0.5.0__tar.gz

{prefab-0.4.6 → prefab-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefab
-Version: 0.4.6
+Version: 0.5.0
 Summary: Machine learning based prediction of photonic device fabrication
 Project-URL: Homepage, https://github.com/PreFab-Photonics/PreFab
 Author-email: Dusan Gostimirovic <dusan@prefabphotonics.com>
@@ -541,16 +541,16 @@ Description-Content-Type: text/markdown
 
 ## Models
 
-`PreFab` accommodates unique _predictor_ and _corrector_ models for each photonic foundry, regularly updated based on recent fabrication data. Current models include (see full list on [`docs/models.md`](docs/models.md)):
+`PreFab` accommodates unique _predictor_ and _corrector_ models for each photonic foundry, regularly updated based on recent fabrication data. Current models include (see full list on [`docs/models.md`](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/models.md)):
 
-| Foundry   | Process                                                                            | Latest Version  | Latest Dataset   | Model Name    | Model Tag   | Status |
-| --------- | ---------------------------------------------------------------------------------- | --------------- | ---------------- | ------------- | ----------- | ------ |
-| ANT       | [NanoSOI](https://www.appliednt.com/nanosoi-fabrication-service/)                  | v5 (Jun 3 2023) | d4 (Apr 12 2023) | ANT_NanoSOI   | v5-d4       | Beta   |
-| ANT       | [SiN (Upper Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023) | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-upper | Alpha  |
-| ANT       | [SiN (Lower Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023) | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-lower | Alpha  |
-| SiEPICfab | [SOI](https://siepic.ca/fabrication/)                                              | v5 (Jun 3 2023) | d0 (Jun 14 2023) | SiEPICfab_SOI | v5-d0       | Alpha  |
+| Foundry   | Process                                                                            | Latest Version   | Latest Dataset   | Model Name    | Model Tag   | Status |
+| --------- | ---------------------------------------------------------------------------------- | ---------------- | ---------------- | ------------- | ----------- | ------ |
+| ANT       | [NanoSOI](https://www.appliednt.com/nanosoi-fabrication-service/)                  | v6 (Nov 24 2023) | d7 (Nov 24 2023) | ANT_NanoSOI   | v6-d7       | Beta   |
+| ANT       | [SiN (Upper Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023)  | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-upper | Alpha  |
+| ANT       | [SiN (Lower Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023)  | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-lower | Alpha  |
+| SiEPICfab | [SOI](https://siepic.ca/fabrication/)                                              | v5 (Jun 3 2023)  | d0 (Jun 14 2023) | SiEPICfab_SOI | v5-d0       | Alpha  |
 
-_New models and foundries are regularly added. Usage may change. For additional foundry and process models, feel free to contact us or raise an issue._
+_New models and foundries are to be added. Usage may change. For additional foundry and process models, feel free to contact us or raise an issue._
 
 ## Installation
 
@@ -578,16 +578,28 @@ Use `PreFab` online through GitHub Codespaces:
 
 ## Getting Started
 
-Visit [`/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/examples) for usage notebooks.
+### Account setup
+
+Before you can make PreFab requests, you will need to [create an account](https://www.prefabphotonics.com/login).
+
+To link your account, you will need a token. You can do this by running the following command in your terminal. This will open a browser window where you can log in and authenticate your token.
+
+```sh
+python3 -m prefab setup
+```
+
+### Guides
+
+Visit [`/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/examples) or our [Guides](https://www.prefabphotonics.com/docs/guides/predictions) to get started with your first predictions.
 
 ## Performance and Usage
 
 `PreFab` models are served via a serverless cloud platform. Please note:
 
-- 🐢 CPU inferencing may result in slower performance. Future updates will introduce GPU inferencing.
+- 🐢 CPU inference may result in slower performance. Future updates will introduce GPU inference.
 - 🥶 The first prediction may take longer due to cold start server loading. Subsequent predictions will be faster.
 - 😊 Be considerate of usage. Start small and limit usage during the initial stages. Thank you!
 
 ## License
 
-This project is licensed under the LGPL-2.1 license. © 2023 PreFab Photonics.
+This project is licensed under the LGPL-2.1 license. © 2024 PreFab Photonics.

{prefab-0.4.6 → prefab-0.5.0}/README.md

@@ -18,16 +18,16 @@
 
 ## Models
 
-`PreFab` accommodates unique _predictor_ and _corrector_ models for each photonic foundry, regularly updated based on recent fabrication data. Current models include (see full list on [`docs/models.md`](docs/models.md)):
+`PreFab` accommodates unique _predictor_ and _corrector_ models for each photonic foundry, regularly updated based on recent fabrication data. Current models include (see full list on [`docs/models.md`](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/models.md)):
 
-| Foundry   | Process                                                                            | Latest Version  | Latest Dataset   | Model Name    | Model Tag   | Status |
-| --------- | ---------------------------------------------------------------------------------- | --------------- | ---------------- | ------------- | ----------- | ------ |
-| ANT       | [NanoSOI](https://www.appliednt.com/nanosoi-fabrication-service/)                  | v5 (Jun 3 2023) | d4 (Apr 12 2023) | ANT_NanoSOI   | v5-d4       | Beta   |
-| ANT       | [SiN (Upper Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023) | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-upper | Alpha  |
-| ANT       | [SiN (Lower Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023) | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-lower | Alpha  |
-| SiEPICfab | [SOI](https://siepic.ca/fabrication/)                                              | v5 (Jun 3 2023) | d0 (Jun 14 2023) | SiEPICfab_SOI | v5-d0       | Alpha  |
+| Foundry   | Process                                                                            | Latest Version   | Latest Dataset   | Model Name    | Model Tag   | Status |
+| --------- | ---------------------------------------------------------------------------------- | ---------------- | ---------------- | ------------- | ----------- | ------ |
+| ANT       | [NanoSOI](https://www.appliednt.com/nanosoi-fabrication-service/)                  | v6 (Nov 24 2023) | d7 (Nov 24 2023) | ANT_NanoSOI   | v6-d7       | Beta   |
+| ANT       | [SiN (Upper Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023)  | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-upper | Alpha  |
+| ANT       | [SiN (Lower Edge)](https://www.appliednt.com/nanosoi/sys/resources/specs_nitride/) | v5 (Jun 3 2023)  | d0 (Jun 1 2023)  | ANT_SiN       | v5-d0-lower | Alpha  |
+| SiEPICfab | [SOI](https://siepic.ca/fabrication/)                                              | v5 (Jun 3 2023)  | d0 (Jun 14 2023) | SiEPICfab_SOI | v5-d0       | Alpha  |
 
-_New models and foundries are regularly added. Usage may change. For additional foundry and process models, feel free to contact us or raise an issue._
+_New models and foundries are to be added. Usage may change. For additional foundry and process models, feel free to contact us or raise an issue._
 
 ## Installation
 
@@ -55,16 +55,28 @@ Use `PreFab` online through GitHub Codespaces:
 
 ## Getting Started
 
-Visit [`/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/examples) for usage notebooks.
+### Account setup
+
+Before you can make PreFab requests, you will need to [create an account](https://www.prefabphotonics.com/login).
+
+To link your account, you will need a token. You can do this by running the following command in your terminal. This will open a browser window where you can log in and authenticate your token.
+
+```sh
+python3 -m prefab setup
+```
+
+### Guides
+
+Visit [`/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/examples) or our [Guides](https://www.prefabphotonics.com/docs/guides/predictions) to get started with your first predictions.
 
 ## Performance and Usage
 
 `PreFab` models are served via a serverless cloud platform. Please note:
 
-- 🐢 CPU inferencing may result in slower performance. Future updates will introduce GPU inferencing.
+- 🐢 CPU inference may result in slower performance. Future updates will introduce GPU inference.
 - 🥶 The first prediction may take longer due to cold start server loading. Subsequent predictions will be faster.
 - 😊 Be considerate of usage. Start small and limit usage during the initial stages. Thank you!
 
 ## License
 
-This project is licensed under the LGPL-2.1 license. © 2023 PreFab Photonics.
+This project is licensed under the LGPL-2.1 license. © 2024 PreFab Photonics.

prefab-0.5.0/prefab/__main__.py

@@ -0,0 +1,81 @@
+"""Main entry point for the Prefab CLI."""
+import argparse
+import os
+import threading
+import webbrowser
+from http.server import BaseHTTPRequestHandler, HTTPServer
+
+import toml
+
+
+def store_jwt_securely(jwt, refresh_token):
+    """
+    Store the JWT and refresh token securely in a TOML file.
+    """
+    prefab_file_path = os.path.expanduser("~/.prefab.toml")
+    with open(prefab_file_path, "w", encoding="utf-8") as toml_file:
+        toml.dump({"access_token": jwt, "refresh_token": refresh_token}, toml_file)
+    print(f"Token successfully stored in {prefab_file_path}")
+
+
+class GracefulHTTPServer(HTTPServer):
+    """An HTTPServer that supports graceful shutdown."""
+
+    def shutdown(self):
+        """Stop the serve_forever loop."""
+        self._BaseServer__shutdown_request = True
+        self.server_close()
+
+
+class CallbackHandler(BaseHTTPRequestHandler):
+    """
+    A request handler for the HTTP server that handles the OAuth callback.
+    """
+
+    def do_GET(self):
+        if self.path.startswith("/callback"):
+            query_params = self.path.split("?")[1]
+            params = {
+                param.split("=")[0]: param.split("=")[1]
+                for param in query_params.split("&")
+            }
+            jwt_token = params.get("token")
+            refresh_token = params.get("refresh_token")
+            if jwt_token and refresh_token:
+                print("Token verified!")
+                store_jwt_securely(jwt_token, refresh_token)
+                self.send_response_only(200, "OK")
+                self.send_header("Content-type", "text/html")
+                self.end_headers()
+                self.wfile.write(
+                    b"Authentication successful, you can close this window."
+                )
+                threading.Thread(target=self.server.shutdown).start()
+            else:
+                self.send_error(400, "Bad Request: Missing tokens in callback URL.")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Prefab CLI")
+    parser.add_argument("command", help="The command to run", choices=["setup"])
+    parser.add_argument(
+        "--port", help="Port number for the HTTP server", type=int, default=8000
+    )
+
+    args = parser.parse_args()
+
+    if args.command == "setup":
+        webbrowser.open("https://www.prefabphotonics.com/token-flow")
+        httpd = GracefulHTTPServer(("localhost", args.port), CallbackHandler)
+        print("Started token authentication flow on the web browser...")
+        try:
+            httpd.serve_forever()
+        except KeyboardInterrupt:
+            pass
+        httpd.server_close()
+    else:
+        print(f"Command {args.command} not recognized.")
+
+
+if __name__ == "__main__":
+    main()

{prefab-0.4.6 → prefab-0.5.0}/prefab/predictor.py

@@ -4,9 +4,13 @@ using machine learning models deployed in the cloud.
 """
 
 import base64
+import os
+
 import numpy as np
 import requests
-from cv2 import imencode, imdecode, IMREAD_GRAYSCALE
+import toml
+from cv2 import IMREAD_GRAYSCALE, imdecode, imencode
+
 from prefab.processor import binarize_hard
 
 
@@ -49,12 +53,47 @@ def predict(
         "device": _encode_image(device),
         "model_name": model_name,
         "model_tags": model_tags,
+        "binary": binarize,
     }
 
-    prediction = _decode_image(
-        requests.post(function_url, json=predict_data, timeout=200)
+    with open(os.path.expanduser("~/.prefab.toml"), "r") as file:
+        content = file.readlines()
+        for line in content:
+            if "access_token" in line:
+                access_token = line.split("=")[1].strip().strip('"')
+            if "refresh_token" in line:
+                refresh_token = line.split("=")[1].strip().strip('"')
+                break
+
+    headers = {
+        "Authorization": f"Bearer {access_token}",
+        "X-Refresh-Token": refresh_token,
+    }
+    response = requests.post(
+        url=function_url,
+        json=predict_data,
+        headers=headers,
     )
 
+    if response.status_code != 200:
+        raise ValueError(response.text)
+    else:
+        response_data = response.json()
+        if "error" in response_data:
+            raise ValueError(response_data["error"])
+        if "prediction" in response_data:
+            prediction = _decode_image(response_data["prediction"])
+        if "new_refresh_token" in response_data:
+            prefab_file_path = os.path.expanduser("~/.prefab.toml")
+            with open(prefab_file_path, "w", encoding="utf-8") as toml_file:
+                toml.dump(
+                    {
+                        "access_token": response_data["new_access_token"],
+                        "refresh_token": response_data["new_refresh_token"],
+                    },
+                    toml_file,
+                )
+
     if binarize:
         prediction = binarize_hard(prediction)
 
@@ -62,7 +101,11 @@ def predict(
 
 
 def correct(
-    device: np.ndarray, model_name: str, model_tags: str, binarize: bool = False
+    device: np.ndarray,
+    model_name: str,
+    model_tags: str,
+    binarize: bool = True,
+    multi_correct: bool = False,
 ) -> np.ndarray:
     """
     Generates a correction for a photonic device using a specified cloud-based ML model.
@@ -84,7 +127,11 @@ def correct(
         Consult the module's documentation for available tags.
 
     binarize : bool, optional
-        If set to True, the correction will be binarized (default is False).
+        If set to True, the correction will be binarized (default is True).
+
+    multi_correct : bool, optional
+        If set to True, the correction will be generated using a iterative approach.
+        (default is False).
 
     Returns
     -------
@@ -100,14 +147,47 @@ def correct(
         "device": _encode_image(device),
         "model_name": model_name,
         "model_tags": model_tags,
+        "binary": binarize,
+        "multi_correct": multi_correct,
     }
 
-    correction = _decode_image(
-        requests.post(function_url, json=correct_data, timeout=200)
+    with open(os.path.expanduser("~/.prefab.toml"), "r") as file:
+        content = file.readlines()
+        for line in content:
+            if "access_token" in line:
+                access_token = line.split("=")[1].strip().strip('"')
+            if "refresh_token" in line:
+                refresh_token = line.split("=")[1].strip().strip('"')
+                break
+
+    headers = {
+        "Authorization": f"Bearer {access_token}",
+        "X-Refresh-Token": refresh_token,
+    }
+    response = requests.post(
+        url=function_url,
+        json=correct_data,
+        headers=headers,
     )
 
-    if binarize:
-        correction = binarize_hard(correction)
+    if response.status_code != 200:
+        raise ValueError(response.text)
+    else:
+        response_data = response.json()
+        if "error" in response_data:
+            raise ValueError(response_data["error"])
+        if "correction" in response_data:
+            correction = _decode_image(response_data["correction"])
+        if "new_refresh_token" in response_data:
+            prefab_file_path = os.path.expanduser("~/.prefab.toml")
+            with open(prefab_file_path, "w", encoding="utf-8") as toml_file:
+                toml.dump(
+                    {
+                        "access_token": response_data["new_access_token"],
+                        "refresh_token": response_data["new_refresh_token"],
+                    },
+                    toml_file,
+                )
 
     return correction
 
@@ -145,7 +225,7 @@ def _decode_image(encoded_image_base64: str) -> np.ndarray:
     np.ndarray
         The decoded image in numpy array format.
     """
-    encoded_image = base64.b64decode(encoded_image_base64.json())
+    encoded_image = base64.b64decode(encoded_image_base64)
     decoded_image = np.frombuffer(encoded_image, np.uint8)
     decoded_image = imdecode(decoded_image, IMREAD_GRAYSCALE) / 255
     return decoded_image

{prefab-0.4.6 → prefab-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "prefab"
-version = "0.4.6"
+version = "0.5.0"
 authors = [
     {name = "Dusan Gostimirovic", email="dusan@prefabphotonics.com"},
 ]