index.rst

Welcome to Pysphalt's documentation!

Pysphalt is a library of machine learning models for Brazilian asphalt material data.

Installation

Install the pysphalt package (or add it to your requirements.txt file):

$ pip install pysphalt

Usage

Import one of the models from the pysphalt.models module, for example the :class:`.AsphaltModulusPredictor` model:

from pysphalt.models import AsphaltModulusPredictor

predictor = AsphaltModulusPredictor()

predictor.predict([[<your sample row 1>], [<your sample row 2>], ...])

.. toctree::
   :maxdepth: 2
   :caption: Python API:

   api/models