fxn 0.0.14__tar.gz → 0.0.16__tar.gz

{fxn-0.0.14 → fxn-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.14
+Version: 0.0.16
 Summary: Run on-device and cloud AI prediction functions in Python. Register at https://fxn.ai.
 Home-page: https://fxn.ai
 Author: NatML Inc.
@@ -27,33 +27,35 @@ Run AI prediction functions (a.k.a "predictors") in your Python apps. With Funct
 ## Installing Function
 Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:
 ```sh
-pip install fxn
+pip install --upgrade fxn
 ```
 
 > Note that Function requires Python 3.9+
 
-## Signing in to Function
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
-
-![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
-
-Now, let's login to the Function CLI with your access key. Open a terminal and run the following command:
-```sh
-fxn auth login <ACCESS KEY>
+## Making a Prediction
+Let's run the [`@samplefxn/stable-diffusion`](https://fxn.ai/@samplefxn/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image.
+
+### In Python
+Run the following Python script:
+```py
+import fxn
+
+prediction = fxn.Prediction.create(
+    tag="@samplefxn/stable-diffusion",
+    prompt="An astronaut riding a horse on Mars"
+)
+image = prediction.results[0]
+image.show()
 ```
 
-You should see information about your Function account:
-
-![login to CLI](https://raw.githubusercontent.com/fxnai/.github/main/auth_login.gif)
-
-## Making a Prediction
-You can start off by running an existing predictor [on Function](https://fxn.ai/explore). Let's run the [`@natml/stable-diffusion`](https://fxn.ai/@natml/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image. In terminal, run the following command:
+### In the CLI
+Open up a terminal and run the following command:
 
 ```sh
-fxn predict @natml/stable-diffusion --prompt "An astronaut riding a horse on the moon"
+fxn predict @samplefxn/stable-diffusion --prompt "An astronaut riding a horse on the moon"
 ```
 
-And within a few seconds, you should see a creepy-looking image pop up 😅:
+Within a few seconds, you should see a creepy-looking image pop up 😅:
 
 ![prediction](https://raw.githubusercontent.com/fxnai/.github/main/predict.gif)
 

{fxn-0.0.14 → fxn-0.0.16}/README.md

@@ -7,33 +7,35 @@ Run AI prediction functions (a.k.a "predictors") in your Python apps. With Funct
 ## Installing Function
 Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:
 ```sh
-pip install fxn
+pip install --upgrade fxn
 ```
 
 > Note that Function requires Python 3.9+
 
-## Signing in to Function
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
-
-![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
-
-Now, let's login to the Function CLI with your access key. Open a terminal and run the following command:
-```sh
-fxn auth login <ACCESS KEY>
+## Making a Prediction
+Let's run the [`@samplefxn/stable-diffusion`](https://fxn.ai/@samplefxn/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image.
+
+### In Python
+Run the following Python script:
+```py
+import fxn
+
+prediction = fxn.Prediction.create(
+    tag="@samplefxn/stable-diffusion",
+    prompt="An astronaut riding a horse on Mars"
+)
+image = prediction.results[0]
+image.show()
 ```
 
-You should see information about your Function account:
-
-![login to CLI](https://raw.githubusercontent.com/fxnai/.github/main/auth_login.gif)
-
-## Making a Prediction
-You can start off by running an existing predictor [on Function](https://fxn.ai/explore). Let's run the [`@natml/stable-diffusion`](https://fxn.ai/@natml/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image. In terminal, run the following command:
+### In the CLI
+Open up a terminal and run the following command:
 
 ```sh
-fxn predict @natml/stable-diffusion --prompt "An astronaut riding a horse on the moon"
+fxn predict @samplefxn/stable-diffusion --prompt "An astronaut riding a horse on the moon"
 ```
 
-And within a few seconds, you should see a creepy-looking image pop up 😅:
+Within a few seconds, you should see a creepy-looking image pop up 😅:
 
 ![prediction](https://raw.githubusercontent.com/fxnai/.github/main/predict.gif)
 

{fxn-0.0.14 → fxn-0.0.16}/fxn/api/predictor.py

@@ -9,7 +9,7 @@ from enum import Enum
 from pathlib import Path
 from typing import Dict, List, Optional, Tuple, Union
 
-from .api import query
+from .api import query as queryfxn
 from .dtype import Dtype
 from .profile import Profile
 from .storage import Storage, UploadType
@@ -111,7 +111,7 @@ class Predictor:
             Predictor: Predictor.
         """
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             query ($input: PredictorInput!) {{
                 predictor (input: $input) {{
                     {cls.FIELDS}
@@ -150,7 +150,7 @@ class Predictor:
             list: User predictors.
         """
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             query ($user: UserInput, $predictors: UserPredictorsInput) {{
                 user (input: $user) {{
                     predictors (input: $predictors) {{
@@ -187,7 +187,7 @@ class Predictor:
         Search predictors.
 
         Parameters:
-            query (str): Search query.
+            q (str): Search query.
             offset (int): Pagination offset.
             count (int): Pagination count.
             access_key (str): Function access key.
@@ -196,7 +196,7 @@ class Predictor:
             list: Relevant predictors.
         """
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             query ($input: PredictorsInput!) {{
                 predictors (input: $input) {{
                     {cls.FIELDS}
@@ -251,7 +251,7 @@ class Predictor:
         notebook = Storage.upload(notebook, UploadType.Notebook) if isinstance(notebook, Path) else notebook
         media = Storage.upload(media, UploadType.Media) if isinstance(media, Path) else media
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             mutation ($input: CreatePredictorInput!) {{
                 createPredictor (input: $input) {{
                     {cls.FIELDS}
@@ -297,7 +297,7 @@ class Predictor:
             bool: Whether the predictor was successfully deleted.
         """
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             mutation ($input: DeletePredictorInput!) {{
                 deletePredictor (input: $input)
             }}
@@ -326,7 +326,7 @@ class Predictor:
             Predictor: Archived predictor.
         """
         # Query
-        response = query(f"""
+        response = queryfxn(f"""
             mutation ($input: ArchivePredictorInput!) {{
                 archivePredictor (input: $input) {{
                     {cls.FIELDS}

{fxn-0.0.14 → fxn-0.0.16}/fxn/cli/predict.py

@@ -9,6 +9,7 @@ from numpy import ndarray
 from pathlib import Path, PurePath
 from PIL import Image
 from rich import print_json
+from rich.progress import Progress, SpinnerColumn, TextColumn
 from tempfile import mkstemp
 from typer import Argument, Context, Option
 
@@ -21,14 +22,20 @@ def predict (
     context: Context = 0
 ):
     # Predict
-    inputs = { context.args[i].replace("-", ""): _parse_value(context.args[i+1]) for i in range(0, len(context.args), 2) }
-    prediction = Prediction.create(
-        tag=tag,
-        **inputs,
-        raw_outputs=raw_outputs,
-        return_binary_path=True,
-        access_key=get_access_key()
-    )
+    with Progress(
+        SpinnerColumn(spinner_name="point"),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True
+    ) as progress:
+        progress.add_task(description="Making prediction...", total=None)
+        inputs = { context.args[i].replace("-", ""): _parse_value(context.args[i+1]) for i in range(0, len(context.args), 2) }
+        prediction = Prediction.create(
+            tag=tag,
+            **inputs,
+            raw_outputs=raw_outputs,
+            return_binary_path=True,
+            access_key=get_access_key()
+        )
     # Parse results
     images = []
     if hasattr(prediction, "results") and prediction.results is not None:

{fxn-0.0.14 → fxn-0.0.16}/fxn/version.py

@@ -3,4 +3,4 @@
 #   Copyright © 2023 NatML Inc. All Rights Reserved.
 #
 
-__version__ = "0.0.14"
+__version__ = "0.0.16"

{fxn-0.0.14 → fxn-0.0.16}/fxn.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fxn
-Version: 0.0.14
+Version: 0.0.16
 Summary: Run on-device and cloud AI prediction functions in Python. Register at https://fxn.ai.
 Home-page: https://fxn.ai
 Author: NatML Inc.
@@ -27,33 +27,35 @@ Run AI prediction functions (a.k.a "predictors") in your Python apps. With Funct
 ## Installing Function
 Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:
 ```sh
-pip install fxn
+pip install --upgrade fxn
 ```
 
 > Note that Function requires Python 3.9+
 
-## Signing in to Function
-Head over to [fxn.ai](https://fxn.ai) to create an account by logging in. Once you do, generate an access key:
-
-![generate access key](https://raw.githubusercontent.com/fxnai/.github/main/access_key.gif)
-
-Now, let's login to the Function CLI with your access key. Open a terminal and run the following command:
-```sh
-fxn auth login <ACCESS KEY>
+## Making a Prediction
+Let's run the [`@samplefxn/stable-diffusion`](https://fxn.ai/@samplefxn/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image.
+
+### In Python
+Run the following Python script:
+```py
+import fxn
+
+prediction = fxn.Prediction.create(
+    tag="@samplefxn/stable-diffusion",
+    prompt="An astronaut riding a horse on Mars"
+)
+image = prediction.results[0]
+image.show()
 ```
 
-You should see information about your Function account:
-
-![login to CLI](https://raw.githubusercontent.com/fxnai/.github/main/auth_login.gif)
-
-## Making a Prediction
-You can start off by running an existing predictor [on Function](https://fxn.ai/explore). Let's run the [`@natml/stable-diffusion`](https://fxn.ai/@natml/stable-diffusion) predictor which accepts a text `prompt` and generates a corresponding image. In terminal, run the following command:
+### In the CLI
+Open up a terminal and run the following command:
 
 ```sh
-fxn predict @natml/stable-diffusion --prompt "An astronaut riding a horse on the moon"
+fxn predict @samplefxn/stable-diffusion --prompt "An astronaut riding a horse on the moon"
 ```
 
-And within a few seconds, you should see a creepy-looking image pop up 😅:
+Within a few seconds, you should see a creepy-looking image pop up 😅:
 
 ![prediction](https://raw.githubusercontent.com/fxnai/.github/main/predict.gif)