salesforce/TransmogrifAI

Allow adding/getting metadata on the model level

Open

#148 opened on Oct 4, 2018

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Scala (2,274 stars) (399 forks)batch import
enhancementgood first issue

Description

Problem We would like to be able to store some types of metadata of the level of the model, e.g instance holdout splits. Currently there is no easy way to store metadata with the trained model, except if not through OpParams, stage metadata or manually if a separate file.

Solution We would like to add two methods to OpWorkflowModel class to allow saving/loading metadata with the model:

class OpWorkflowModel { 
   def addMetadata[T <: Product](name: String, value: T): this.type
   def getMetadata[T <: Product](name: String): Try[T]
}

Alternatives Store metadata in custom map in OpParams or in a separate file.

Additional context N/A

Contributor guide

Tech stack
scalaspark
Domain
machine learningapi
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaApache Spark basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the OpWorkflowModel class in the TransmogrifAI library (likely in OpWorkflowModel.scala). Understand how the model currently stores data and how to add a metadata map. Check existing tests for similar methods. Implement the addMetadata and getMetadata methods as described, ensuring type safety with Product types. Consider using a map and serialization for persistence.
Allow adding/getting metadata on the model level · salesforce/TransmogrifAI#148 | Good First Issue