fastqlapi 0.3.4

No project description provided

FastQL Inference Server

Spin up a blazing fast Rust GraphQL API and query around your ML model in one line of python code.

We include an example which can deploy and serve stable diffusion / runwayml / midjourney or any of the diffusers models in seconds.

We've observed about a 2x speed up across the example schema vs a FastAPI/Ariadne python GraphQL server with identical schema. This is because although the model code is in python, the API is actually a Rust process running ActiX.

Please note

• Does not include an auth mechanism, you can implement auth using an API Gateway or auth proxy.
• Can only create flat / non nested schema.
• Make sure you set RUST_ENV to production if you are using it on a remote machine.
• This is currently a prototype and should not be used in production.

Why would I need FastQL?

• FastQL encourages seperation of your API and model, allowing you to focus on your model code, making PRs with your model code completely detached from the API layer.
• All the benefits of GraphQL... Fetch data with single API call, no overfetching, autogenerated API documentation, validation and type checking out-of-the-box, API evolution without versioning, subscriptions (websockets) as a first class citizen (to be implemented soon).
• FastQL is really fast, much faster than a pure python implementation, the example schema has a latency of < 20ms when tested locally.
• FastlQL is Apollo federation compliant, which means that you can aggregate many models into a single curated API using schema stitching. This means you can maintain both fixed and dynamic schema's for params to your models, so it is easy to test new features and benefit from federation versioning.
• FastQL gives you GraphQL playground for testing and demonstrating your prototype models.
• Because ML models are typically sequential in terms of request response pattern, requests to the model are always blocking,response time is the important bottleneck FastQL is focused on reducing.

Installation

pip install fastqlapi

Usage

Visit localhost:8000/graphiql for the graphql playground UI or make a request to localhost:8000.

example:

from fastqlapi import fastql_server
def infer(**kwargs):
    print (kwargs['input'])
    return {
        'output': "test response",
    }

fastql_server.start(callback=infer, query_name="Model", args={"input": { "type": "String", "description": "this is my input field"}}, fields={"output": { "type": "String"}})

or try with the example schema:

from fastqlapi import fastql_server, test_args, test_fields

def infer(**kwargs):
    print (kwargs['prompt'])
    return {
        "tokens": ["example", "tokens"],
    }

fastql_server.start(callback=infer, args=testargs, fields=testfields)

Spin up an example hugging face diffusers GraphQL API using Docker on AWS EC2

NB. these examples are not suitable for production

• Launch an EC2 GPU powered instance (for example p3.2xlarge)
• Search for NVIDIA GPU-Optimized PyTorch AMI in the Amazon Machine Image search bar.
• Select this AMI and configure storage to 64GIB.
• You will need to set a PEM key-pair, download and chmod the key on your local machine using chmod 400 {{key pair name}}.
• Launch your instance.
• In the security tab for your instance select the auto-created or chosen security group and add an inbound rule setting custom TCP and port 8000 (graphql api) to 0.0.0.0/0 (or more appropriate scoped access) and another setting port 8080 (image server) to 0.0.0.0/0.-
• Sign up at https://huggingface.co/ to get your free ACCESS_TOKEN.
• Setup aws configure with the command aws configure and enter access key details after creating an access key in the IAM panel.
• Run the following commands to set your public IP:

EC2_INSTANCE_ID="`wget -q -O - http://169.254.169.254/latest/meta-data/instance-id || die \"wget instance-id has failed: $?\"`"
export PUBLIC_IP=$(aws ec2 describe-instances --instance-ids $EC2_INSTANCE_ID --query 'Reservations[*].Instances[*].PublicIpAddress' --output text)

• Connect to your instance and use our example docker image on danfreshbc/fastqlapi-diffusers or run your published docker image similar to:

docker run -p 8000:8000 -p 8080:8080 \
    -e PUBLIC_IP=$PUBLIC_IP \
    -e MODEL_ID="stabilityai/stable-diffusion-2" \
    --gpus all danfreshbc/fastqlapi-diffusers:latest

• You can echo $PUBLIC_IP to get your public IP or find it in your EC2 console instance details.
• Connect to {{EC2_PUBLIC IP}}:8000/graphql to visit your new GraphQL API and make sure that the URL next to the history button contains {{EC2_PUBLIC IP}}:8000
• An example query:

{
  Model1(prompt: "a handsome man holding a baby goat") {
    images
  }
}

You can change MODEL_ID to one of the following to try a different diffusers model for example:

"CompVis/stable-diffusion-v1-4"
"stabilityai/stable-diffusion-2"
"runwayml/stable-diffusion-v1-5"

The example API surfaces prompt, number_of_images, guidance_scale, number_inference_steps and seed and returns an array of images or a seed.

A further diffusers example implementing fine tuning

NB. This should use a mutation, mutation support coming soon!

• Setup your instance as above but with a machine with more than 16GB ram for example m5.2xlarge
• Use the following docker command:

docker run -p 8000:8000 -p 8080:8080 \
    -e PUBLIC_IP=$PUBLIC_IP \
    -e MODEL_ID="stabilityai/stable-diffusion-2" \
    --gpus all danfreshbc/fastqlapi-diffusers:latest bash start_finetune.sh

To start finetuning use a query like below:

{
  Model(
    fine_tune_photo_description: "Photo of happymachine"
    gdrive_folder_of_images_link: "https://drive.google.com/drive/folders/17g_m3eaBA6SJQP-xppGkAHXYoKCLObZg"
  ) {
    images
  }
}

To infer:

{
  Model(prompt: "happymachine standing in front of an F1 McLaren") {
    images
  }
}

Further info

• FastQL implements all the basic GraphQL types and array types, including required types but not currently required subtypes (an element of a list).

• Using types URL, URL!, [URL] or [URL!] in python code will translate to GraphQL String equivalents, but will cause a valid URL that is sent under that type to be downloaded.

• Under the hood FastQL uses the actix rust web server which is currently no.5 fastest web framework according to Tech Empower. By comparison, Python's FastAPI is at no.93. We've observed about a 2x speed up across the example schema here vs a FastAPI/Ariadne python GraphQL server with the same schema.

Environment variables

GRAPHQL_HOST Default localhost

GRAPHQL_PORT Default 8000

UPLOAD_PATH Path to download files given as a value for URL types | default ./

MODEL_ID The diffusers model ID for the huggingface diffusers model you want to launch

ACCESS_TOKEN Your huggingface diffusers access token

ENABLE_GRAPHIQL Will enable GraphiQL | default to true unless RUST_ENV is set to production (in which case setting ENABLE_GRAPHIQL=true will still overide)

ENABLE_CORS default false

CORS_PERMISSIVE Should be used in Development/Test only, allows all headers and origins, credentials supported, maximum age 1 hour does not send wildcard | default false

ALLOW_AUTHORIZATION_HEADER default false

ALLOW_ORIGIN_HEADER default false

ALLOW_CONTENT_TYPE_HEADER default false

MAX_AGE_HEADER default 3600

RUST_LOG Rust log level | default 'debug'

RUST_BACKTRACE Add rust backtrace to log | default 1

RUST_QUIET No rust logs | default false

TRACING Turn on Apollo tracing | default false

License

The code in this repo is released under the MIT license.

Thank you

The folks at Hugging Face
The team at Actix
Sunli @ Async-graphql.rs
The team at Maturin