butterfree.reports package¶
Submodules¶
Write feature set metadata.
- class butterfree.reports.metadata.Metadata(pipeline: FeatureSetPipeline, save: bool = False)¶
Bases:
object
Generate metadata for feature set pipeline.
- pipeline¶
object processed with feature set pipeline.
- save¶
bool value with default is False. When this value is True, it will generate a file.
Example
>>> pipeline = FeatureSetPipeline() >>> metadata = Metadata(pipeline) >>> metadata.to_json()
[¶
“feature_set”: “feature_set”, “description”: “description”, “source”: [
- {
“reader”: “Table Reader”, “location”: “db.table”
}, {
“reader”: “File Reader”, “location”: “path”
}
], “sink”: [
- {
“writer”: “Historical Feature Store Writer”
}, {
“writer”: “Online Feature Store Writer”
}
], “features”: [
- {
- “column”: {
“name”: “user_id”, “data_type”: “IntegerType”
}, “description”: “The user’s Main ID or device ID”
}, {
- “column”: {
“name”: “timestamp”, “data_type”: “TimestampType”
}, “description”: “Time tag for the state of all features.”
}, {
- “column”: {
- “name”:
“listing_page_viewed__rent_per_month__avg_over_7_days_fixed_windows”,
“data_type”: “FloatType”
}, “description”: “Average of something.”
}, {
- “column”: {
- “name”:
“listing_page_viewed__rent_per_month__avg_over_2_weeks_fixed_windows”,
“data_type”: “FloatType”
}, “description”: “Average of something.”
}
]
}¶
- to_json() Any ¶
Generate json file.
- to_markdown() Any ¶
Generate markdown file.
Module contents¶
Reports module.
- class butterfree.reports.Metadata(pipeline: FeatureSetPipeline, save: bool = False)¶
Bases:
object
Generate metadata for feature set pipeline.
- pipeline¶
object processed with feature set pipeline.
- save¶
bool value with default is False. When this value is True, it will generate a file.
Example
>>> pipeline = FeatureSetPipeline() >>> metadata = Metadata(pipeline) >>> metadata.to_json()
[¶
“feature_set”: “feature_set”, “description”: “description”, “source”: [
- {
“reader”: “Table Reader”, “location”: “db.table”
}, {
“reader”: “File Reader”, “location”: “path”
}
], “sink”: [
- {
“writer”: “Historical Feature Store Writer”
}, {
“writer”: “Online Feature Store Writer”
}
], “features”: [
- {
- “column”: {
“name”: “user_id”, “data_type”: “IntegerType”
}, “description”: “The user’s Main ID or device ID”
}, {
- “column”: {
“name”: “timestamp”, “data_type”: “TimestampType”
}, “description”: “Time tag for the state of all features.”
}, {
- “column”: {
- “name”:
“listing_page_viewed__rent_per_month__avg_over_7_days_fixed_windows”,
“data_type”: “FloatType”
}, “description”: “Average of something.”
}, {
- “column”: {
- “name”:
“listing_page_viewed__rent_per_month__avg_over_2_weeks_fixed_windows”,
“data_type”: “FloatType”
}, “description”: “Average of something.”
}
]
}¶
- to_json() Any ¶
Generate json file.
- to_markdown() Any ¶
Generate markdown file.