feathr-ai/feathr

Add capability to enforce certain fields for feature definition

Open

#264 创建于 2022年5月17日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Scala (1,929 star) (244 fork)batch import
good first issue

描述

For project owners or administrators, they may want certain fields of anchor, key or features to be filled by their users(data scientists), like documentation fields for feature, key description field for key etc.

Project owners or admins should be able to set this in the project yaml config like the following:

required fields:
    features:
         feature_type
         feature_documentation
    keys:
        - key description

Relevant code can be found at build_feature(https://github.com/linkedin/feathr/blob/main/feathr_project/feathr/client.py#L214) or tthe logic can be enforced during corresponding object creation phase(https://github.com/linkedin/feathr/blob/main/feathr_project/feathr/feature.py).

贡献者指南

技术栈
python
领域
backenddata
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python programmingUnderstanding of YAML configFamiliarity with Feathr feature definition
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Implement a configuration option in the project YAML to specify required fields for features and keys. Modify the build feature function in feathr project/feathr/client.py (line 214) to validate required fields during feature creation. Additionally, enforce constraints in the feature object creation phase in feathr project/feathr/feature.py.