MK-AI Python Module Documentation

Demo Video

Installation

To install the MK-AI module, run the following comand in your terminal:

pip install MK-AI

MK-AI also requires a pre-existing installation of Google Chrome.

Getting Started

To get started, import the module:

import mk_ai

If you want to directly import the main class:

from mk_ai.MKAI import MKAI

After importing the module, you can use the MKAI class to classify the star.

from mk_ai.MKAI import MKAI
classifier = MKAI() # create a new MKAI object
classifier.classify("<your image path here>")

Usage

Instantiation:

MKAI(self, headless: bool=True, verbose: bool=False, timeout: float=30) -> None
"""
Construct a new 'MKAI' object.
:param headless: Whether or not to use a headless Chrome webdriver
                 (whether or not Chrome will show up on your screen when you run the module).
                 By default, set to False.
:param verbose: Whether or not to print out information about the module's progress.
                By default, set to False.
:param timeout: The maximum amount of time (in seconds) to wait for the classification to be retrieved.
                By default, set to 30 seconds.
:return: returns nothing
"""

Classification:

MKAI().classify(self, image_path: str, url: bool=False) -> tuple
"""
Makes a request call to the MK-AI website and returns the classification and confidence of the star.
:param image_path: The path to the image of the star.
:param url: Whether or not the image_path is a URL.
:return: A tuple containing the classification and confidence of the star.
"""