https://github.com/jesse-sealand/skylite
Manage model artifacts throughout the model development process.
https://github.com/jesse-sealand/skylite
model-development modeling organization-tool python
Last synced: 15 days ago
JSON representation
Manage model artifacts throughout the model development process.
- Host: GitHub
- URL: https://github.com/jesse-sealand/skylite
- Owner: jesse-sealand
- License: other
- Created: 2025-05-04T14:26:21.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2025-05-04T15:31:56.000Z (24 days ago)
- Last Synced: 2025-05-04T16:20:08.356Z (24 days ago)
- Topics: model-development, modeling, organization-tool, python
- Language: Python
- Homepage: https://skylite.readthedocs.io/en/latest/
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Skylite
The aim of this project is to create a minimalist approach to managing artifacts generated throughout the model development process.
## Table of Contents
- [Main Features](#main-features)
- [Where to get it](#where-to-get-it)
- [Dependencies](#dependencies)
- [Change log](#change-log)
- [License](#license)
- [Documentation](#documentation)
## Main Features
- **Project**:
A Project is the single element that manages all of your tasks.
- **Store**:
A Store is the single element that manages all artifacts of a single type, across all projects.
## Where to get it
The source code is currently hosted on GitHub at:
https://github.com/jesse-sealand/skylite
The latest released version are available at
[Python Package Index (PyPI)](https://pypi.org/project/skylite/).
```sh
pip install skylite
```
## Examples
```python
from skylite import Exchange
# Settings
home_directory = '~/Documents'
settings = {
"exchange_name": "Exchange",
"available_stores": ["data-store", "model-store", "result-store", "project-store"],
}
# Setup
SkyLight = Exchange(home_directory, settings)
SkyLight.open_exchange()
# Create Project
PROJECT_NAME = 'aerial-imagery5'
SkyLight.create_project(PROJECT_NAME)
sky_proj = SkyLight.open_project(PROJECT_NAME)
# Start adding model artifacts when modeling
for i in range(0,10):
# Create new instance of Trial
sky_proj.create_trial()
"""
Perform Modeling / scoring / analysis
"""
# Store artifacts for this Trial
data_dict = {'train': df,
'test': df,
'score': df}
model_dict = {'model': clf}
results_dict = {'accuracy': 0.98,
'f1-score': 0.75
}
sky_proj.store_objects('data-store', data_dict)
sky_proj.store_objects('model-store', model_dict)
sky_proj.store_objects('result-store', results_dict)
# close instance of trial and save artifacts
sky_proj.close_trial()
```
## Dependencies
- [TinyDB](https://tinydb.readthedocs.io/en/latest/) A tiny, document oriented database.
## Change Log
See the [change log] for a detailed list of changes in each version.
## License
This extension is [licensed under the MIT License].
[change log]: https://github.com/jesse-sealand/skylite/blob/main/CHANGELOG.md
[licensed under the mit license]: https://github.com/jesse-sealand/skylite/blob/main/LICENSE.txt
## Documentation
The official documentation is hosted on [Read the Docs](http://skylite.readthedocs.io/).