Awesome

Web-API

Summary

API specification for deploy the detection models, this repository contains a performant, production-ready reference implementation.

Data Flow

Documentation

See https://rentadronecl.github.io/docs for tutorials and more guides.

Forum

This project is part of the UNICEF Innovation Fund Discourse community. You can post comments or questions about each category of Rentadrone Developers algorithms. We encourage users to participate in the forum and to engage with fellow users.

Developers

Help improve our software! We welcome contributions from everyone, whether to add new features, improve speed, fix existing bugs or add support. Check our code of conduct, the contributing guidelines and how decisions are made.

Any code contributions are welcomed as long as they are discussed in Github Issues with maintainers. Be aware that if you decide to change something and submit a PR on your own, it may not be accepted.

Creating an issue

To encourage active collaboration, we strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix. For more information, see the templates for filling issues.

Template	Description	Example
Feature request	Suggest an idea for this project	template
Bug report	Create a report to help us improve	template

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. If you want to chip in, you can help out by fixing any bugs listed in our issue trackers.

Requirements

Python 3.6+

Quickstart

In the root project execute the following command to install all dependencies project

pip install -r requirements.txt

You will also need an ASGI server, for production such as Uvicorn or Hypercorn.

pip install uvicorn

Configuration

Configuration Files

All of the configuration files for the API are stored in the config directory. Each option is documented, so feel free to look through the files and get familiar with the options available to you.

Application Key

The next thing you should do after installing is set your application key to a random string.

Typically, this string should be 32 characters long. The key can be set in the .env environment file. If you have not copied the .env.example file to a new file named .env, you should do that now. If the application key is not set, your user sessions and other encrypted data will not be secure!

Model Configuration

The model that we are going to deploy is for predicting photovoltaic fault. You can get the data here.

Model	Weights Trained	Config
SSD7 Panel	weight	config
SSD300 Soiling	weight	config
YOLO3 Panel	weight	config
YOLO3 Soiling	weight	config
YOLO3 Diode	weight	config
YOLO3 Affected Cell	weight	config

We start by loading the data and compiled models into the storage/model folder and the configuration files for each model in the storage/config folder and saving the names of the features that we want to use in our model.

Example model configuration file

{
  "model": {
    "min_input_size": 400,
    "max_input_size": 400,
    "anchors": [5,7, 10,14, 15, 15, 26,32, 45,119, 54,18, 94,59, 109,183, 200,21],
    "labels": ["1"],
    "backend": "full_yolo_backend.h5"
  }
}

After we have prepared the data and saved all necessary files it is time to start creating the API to serve our model from.

NOTE: There are several methods for saving a model, each with its own sets of pros and cons you may change in function of your necessity.

Run it

Run the server with:

uvicorn run:app --reload

<details markdown="1"> <summary>About the command <code>uvicorn run:app --reload</code>...</summary>

The command uvicorn run:app refers to:

run: the file run.py (the Python "module").
app: the object imported inside of run.py with the line from app import app.
--reload: make the server restart after code changes. Only do this for development.

</details>

You already created an API that:

Receives HTTP requests in the path /prediction.
/prediction path take POST <em>operations</em> (also known as HTTP methods).
The path parameter should be parse as json object.
If the mimetype does not indicate JSON application/json this returns None.

Example of an input data

[
  {
    "id": 3,
    "url": "https://domain.com/storage/3/0074.jpg"
  },
  {
    "id": 6,
    "url": "https://domain.com/storage/6/0045.jpg"
  },
  {
    "id": 7,
    "url": "https://domain.com/storage/7/0055.jpg"
  },
  {
    "id": 8,
    "url": "https://domain.com/storage/8/0024.jpg"
  },
  {
    "id": 2,
    "url": "https://domain.com/storage/2/0078.jpg"
  },
  {
    "id": 5,
    "url": "https://domain.com/storage/5/0091.jpg"
  },
  {
    "id": 4,
    "url": "https://domain.com/storage/4/0089.jpg"
  }
]

Viewing Results

[
  {
    "id": 3,
    "url": "https://domain.com/storage/3/0074.jpg",
    "objects": []
  },
  {
    "id": 6,
    "url": "https://domain.com/storage/6/0045.jpg",
    "objects": [
      {
        "class": "1",
        "label": "Soiling Fault",
        "score": -1,
        "xmax": 98,
        "xmin": 86,
        "ymax": 100,
        "ymin": 100
      },
      {
        "class": "1",
        "label": "Soiling Fault",
        "score": -1,
        "xmax": 256,
        "xmin": 243,
        "ymax": 104,
        "ymin": 104
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 14,
        "xmin": 0,
        "ymax": 49,
        "ymin": 49
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 231,
        "xmin": 218,
        "ymax": 56,
        "ymin": 56
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 231,
        "xmin": 218,
        "ymax": 59,
        "ymin": 59
      }
    ]
  },
  {
    "id": 7,
    "url": "https://domain.com/storage/7/0055.jpg",
    "objects": []
  },
  {
    "id": 8,
    "url": "https://domain.com/storage/8/0024.jpg",
    "objects": []
  },
  {
    "id": 2,
    "url": "https://domain.com/storage/2/0078.jpg",
    "objects": [
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 364,
        "xmin": 347,
        "ymax": 329,
        "ymin": 329
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 367,
        "xmin": 343,
        "ymax": 329,
        "ymin": 329
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 366,
        "xmin": 350,
        "ymax": 329,
        "ymin": 329
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 369,
        "xmin": 347,
        "ymax": 329,
        "ymin": 329
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 361,
        "xmin": 347,
        "ymax": 334,
        "ymin": 334
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 366,
        "xmin": 349,
        "ymax": 333,
        "ymin": 333
      },
      {
        "class": "4",
        "score": -1,
        "label": "Diode Fault",
        "xmax": 367,
        "xmin": 349,
        "ymax": 331,
        "ymin": 331
      }
    ]
  },
  {
    "id": 5,
    "url": "https://domain.com/storage/5/0091.jpg",
    "objects": []
  },
  {
    "id": 4,
    "url": "https://domain.com/storage/4/0089.jpg",
    "objects": []
  }
]

FAQs

Current version

Important: The default version of the API may change in the future. If you're building an application and care about the stability of the API, be sure to fork the master branch.

Media types

The Media Type is specified in header of request. The most basic media types the API supports are:

application/json

Neither of these specify a version, so you will always get the current default JSON representation of resources.

For any media type format that is not supported, the Api should return a 406 Not Acceptable status code.

Troubleshooting

If you're encountering some oddities in the API, here's a list of resolutions to some of the problems you may be experiencing.

Why am I getting a 404?

The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications

Why am I not seeing all my results?

Most API calls accessing a list of resources (e.g., users, issues, etc.). If you're making requests and receiving an incomplete set of results, a response is specified in an unsupported content type.

Why am I getting a 500?

Server Mistake - Indicates that something went wrong on the server that prevent the server from fulfilling the request.

Third-party libraries

Contribution guidelines

If you want to contribute to Rentadrone.cl, be sure to review the contribution guidelines. This project adheres to Contributor Covenant's code of conduct. By participating, you are expected to uphold this code.

**We use GitHub issues for tracking requests and bugs, please see

for general questions and discussion, and please direct specific questions to the team of Rentadrone.cl.**

Code of Conduct

The code of conduct is derived from the Contributor Covenant. Any violations of the code of conduct may be reported to Rentadrone.cl

License

open-source software licensed under the MIT license.