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.1-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file openfs-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: openfs-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.0

File hashes

Hashes for openfs-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d7b11d567f75289a734eb3dcb36edd93383d87c2cd68118b10ba48f8c635b723
MD5 43b9d1393cdca360eb907e29729cf96d
BLAKE2b-256 d4a58e689ebde5d8e6bb768f375fff2052f4dc3a095e7c64f1fcb28c5257a5ec

See more details on using hashes here.

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