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 (399 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (2,274 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the OpWorkflowModel class implementation and its serialization mechanism. Identify where metadata can be stored (e.g., within the model's companion object or as a separate serializable field). Implement addMetadata and getMetadata methods using a Map[String, Product] with appropriate serialization.
Tech stack
scala
Domain
machine learningbackend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaApache SparkTransmogrifAI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65