Registration & installation

First things first

Before getting your hands dirty with the project, you need to sign up for an account and install our Python API. Otherwise, you won’t be able to upload models and datasets to Openlayer and enjoy the thrills of conducting error analysis on a beautifully designed ecosystem.

Creating an account

The first step is to navigate to our web app (or desktop app, if you've been delivered a build) and sign up for an account. You can sign up on our web app here.

Finding your API keys

After you create an account and log in, you will have access to different tools within the platform. For now, it’s important that you know where to find your API key, which is what you will use to upload models and datasets.

After you log in, on the sidebar click on Account,. On the Account page, under Keys, you will find your API key.

Installation

Now that you already have an account and know where to find your API key, it’s time to install our Python API.

Install Openlayer

Openlayer works best with Python versions above 3.8, so make sure that you have a compatible version on your machine.

There is a simple way to install Openlayer with pip. You can simply:

$ pip install openlayer

Verify installation

To verify if the Openlayer Python API was installed properly, open your shell and type:

$ pip show openlayer

If Openlayer was correctly installed, you should see a summary of important information, such as the version, our home page address, among others.

🛠️

Reach out

Currently, we only offer a Python API. If you need support for other programming languages, please reach out!

Now, you are ready to move on to the next step!