QuantConnect / QuantConnect/Lean

Provide Name property for all framework components

Open
#3,839 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature framework good first issue
Dominant language
C#
Stars
21.7k
Forks
5.3k
Avg merge
2d 22h
Merged PRs (30d)
34

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing alpha model name implementations, then identify the framework models and optimizers that need matching Name properties. Use the proposed TypeNameMinusInterface(arg1,arg2,...argn) pattern and confirm that every framework model and optimizer has a consistent, uniquely identifying name.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.