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.