Skip to main content

An S3 feature store client for data pipelines.

Project description



openfs

An S3 feature store client for data pipelines.

Python PyPi License: MIT Downloads

Openfs provides a simple api to boost the quality of your training data while keeping your data pipelines clean and manageable.

Installation

pip install openfs

Quick Start

Creating a Store

import openfs as fs
from openfs.stores import FeatureStore
from openfs.boosters import Booster
import os

# <- import files to upload here

# Connect to store bucket
fs.client.connect(
    region_name=os.environ['FSTORE_REGION'],
    endpoint_url=os.environ['FSTORE_ENDPOINT_URL'],
    access_key_id=os.environ['FSTORE_ACCESS_KEY'],
    secret_access_key=os.environ['FSTORE_SECRET_KEY']
)

# Create store
store = FeatureStore("store_name", "description of store", "some_primary_key")

# Upload store
response = store.upload(files, filenames)

Creating a Booster Dataset

# Create booster
booster = Booster(store_id=response['store_id'])

# Add features
booster.add_single("feature_1", alias="alias_for_feature")
booster.add_group(["feature_2", "feature_3"], alias="grouped_feature", how='sum')

# pull features from store (for testing)
df = booster.create_df()

# upload booster
booster.upload(name="booster_name", description="booster description")

Viewing Stores

fb.client.list_stores()



Contributors

We'd love to welcome contributors to openfs to help make training data richer and more open for everyone. We're working on our contributor docs at the moment, but if you're interested in contributing, please send us a message at contact@xplainable.io.





Thanks for trying openfs!

Made with ❤️ in Australia


© copyright xplainable pty ltd

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

openfs-1.0.2-py3-none-any.whl (90.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page