QuantConnect/Lean

Provide Name property for all framework components

Open

#3,839 opened on Nov 14, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,772 forks)batch import
featureframeworkgood first issue

Repository metrics

Stars
 (18,979 stars)
PR merge metrics
 (Avg merge 1d 17h) (43 merged PRs in 30d)

Description

Expected Behavior

Framework models are uniquely identifiable via a name.

Actual Behavior

Only alpha models define a name.

Potential Solution

Use a similar approach as we did we alpha models to add a name for each framework model as well as the optimizers. I'm thinking names would follow the form: <TypeNameMinusInterface>(arg1,arg2,...argn) for example, for the MinimumVariancePortfolioOptimizer with default arguments: MeanVariance(-1,1,0.02)

I'll be updating the alpha model names, so whomever works this can use those as a pattern reference.

Checklist

  • I have completely filled out this template
  • I have confirmed that this issue exists on the current master branch
  • I have confirmed that this is not a duplicate issue by searching issues
  • I have provided detailed steps to reproduce the issue

Contributor guide

Research direction
Examine the naming pattern used for alpha models in the source code, then apply a similar approach to add a name property to all framework models and optimizers. Use the format '<TypeNameMinusInterface>(arg1,arg2,...argn)' as a guide.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
C#QuantConnect Lean framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60