feathr-ai/feathr

Add capability to enforce certain fields for feature definition

Open

#264 opened on May 17, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (1,929 stars) (244 forks)batch import
good first issue

Description

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).

Contributor guide

Tech stack
python
Domain
backenddata
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingUnderstanding of YAML configFamiliarity with Feathr feature definition
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.