Installation

Installing the Qwak SDK

In this quickstart guide, you'll learn how to deploy your first ML model on Qwak within minutes.

❗️

Please note that Qwak currently supports Python versions 3.7.x to 3.9.x.

1. Create a new virtual environment using your preferred Python framework, such as virtualenv, poetry or conda. Please use Python versions 3.7.x to 3.9.x.
2. Install the Qwak SDK in your virtual environment with the following command:

pip install qwak-sdk

poetry add qwak-sdk

This will install the Qwak SDK and CLI client, which you'll use to interact with the Qwak platform.

📘

Mac M1 Users

If you are installing the Python SDK on a Mac with an M1 chip, do not install Rosetta. The SDK is compatible with the native M1 architecture.

Configuring Qwak SDK

The first step is configuring your personal API key.

Log in to Qwak and copy your API key from the settings page.

Open the terminal and type in the following command:

qwak configure

Paste your personal API key when prompted:

Please enter your API key:

Alternatively, configure the API key a single command.

Replace <YOUR_API_KEY> with your API key and ensure to wrap the token in double quotation marks:

qwak configure --api-key "<YOUR_API_KEY>"

After successfully configuring your API key, the below message will appear:

User succesfully configured

Troubleshooting

Unrecognized qwak Command

If your local system fails to recognize the qwak command, ensure it's added to your system's PATH environment variable.

Read/Write Permission Issues

Should you face issues related to read/write permissions with the following error message:

Could not read user configuration from <home_path>/.qwak/config. Please make sure one has been set using qwak configure command.

Manually create the .qwak directory in your home path and rerun the configure command:

mkdir -p <home_path>/.qwak

Additional Troubleshooting

_For any other issues with installing and configuring your Qwak SDK please refer to Installation Issues or Performance Issues pages.