Metadata-Version: 2.1
Name: granular-engine
Version: 0.1.0
Summary: Experiment tracking for GeoSpatial Machine Learning on GeoEngine
Home-page: https://github.com/granularai/engine
License: MIT
Author: Sagar Verma
Author-email: sagar@granular.ai
Requires-Python: >=3.7.0,<4.0.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: yacs (>=0.1.8,<0.2.0)
Project-URL: Repository, https://github.com/granularai/engine
Description-Content-Type: text/x-rst

===================
Engine
===================

A Utility Library that assists in Geospatial Machine Learning Experiment Tracking.

Installation
------------

```pip install granular-engine```


Usage
-----

>>> from engine import Engine
>>>
>>> # Make a config.yaml with GeoEngine projectId and exportId and other necessary details
>>> engine = Engine("config.yaml")
>>>
>>> for epoch in enumerate(epochs):
>>>   # train 
>>>   # eval
>>>   engine.log(step=epoch, train_loss=train_loss, val_loss=val_loss)
>>>
>>> engine.done()


License
-------
GPLv3

Documentation
-------------

View documentation `here <https://engine.granular.ai/>`_

