OversightML Tile Server

The OversightML Tile Server (TS) is a lightweight, cloud-based tile server which allows you to quickly pass an image from S3 bucket to get metadata, image statistics, and set of tiles in real-time.

Table of Contents

• Getting Started
  • Package Layout
  • Prerequisites
  • Running Tile Server Locally
• Support & Feedback
• Security
• License

Getting Started

Package Layout

• /src: This is the Python implementation of this application.
• /test: Unit tests have been implemented using pytest.
• /doc: Contains Sphinx Doc configuration which is used to generate documentation for this package
• /load-test: Contains sample Locust configuration files which is used to run load test against the Tile Server

Documentation

• APIs: You can find API documentation for the OSML Tile Server hosted on our GitHub project page. Keep in mind that the Try it out button functionality does not work in Github project page.
  • Alternatively, if you are working from the source code running docker build, you can find the latest API documentation by booting up the Tile Server by visiting http://0.0.0.0:8080/latest/docs or http://0.0.0.0:8080/latest/redoc. With this approach, you can use Try it out functionality.

Prerequisites

First, ensure you have installed the following tools locally

• docker
• docker compose
• tox

Cloning the repository

Clone the repository to your local computer using

git clone https://github.com/aws-solutions-library-samples/osml-tile-server.git

Navigate to the cloned directory using cd or dir, depending on your operating system.

More information about cloning and managing repositories can be found in the GitHub Docs.

Building the Infrastructure

Tile Server infrastructure is contained in the associated CDK repository, and a sample can be deployed by following the instructions in the Guidance for Overhead Imagery Inference on AWS repository.

Running Tile Server Locally

The Tile Server is designed to be able to be run locally using docker compose for development and testing purposes using docker compose.

Note: Some operating systems may use docker-compose instead of docker compose .

Configure your AWS credentials for the account in which the Tile Server infrastructure was deployed by setting your environment variables.

export AWS_DEFAULT_REGION=<region where TS infrastructure deployed in>
export AWS_ACCESS_KEY_ID=<AKIAIOSFODNN7EXAMPLE>
export AWS_SECRET_ACCESS_KEY=<wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY>

Start the Tile Server using

docker compose up -d

To view the live log output while the server is running

docker logs -f osml-tile-server

To stop the tile server

docker compose down

To rebuild the docker image after making a code change, use

docker compose up -d --build

In another terminal to invoke the rest server and return the viewpoint on a single image, run the following command:

curl -X 'POST' \
  'http://localhost:8080/latest/viewpoints/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "bucket_name": "<S3 Bucket>",
  "object_key": "<Image Name>",
  "viewpoint_name": "test",
  "tile_size": 512,
  "range_adjustment": "NONE"
}'

Additionally, you can head over to FastAPI homepage and be able to execute various of API calls by visiting

http://0.0.0.0:8080/latest/docs or http://0.0.0.0:8080/latest/redoc

Support & Feedback

To post feedback, submit feature ideas, or report bugs, please use the Issues section of this GitHub repo.

If you are interested in contributing to OversightML Model Runner, see the CONTRIBUTING guide.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.