Skip to content

Better documentation and discoverability around Append and Transfomer Scope #3098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
singlis opened this issue Mar 26, 2019 · 1 comment
Open
Labels
documentation Related to documentation of ML.NET P2 Priority of the issue for triage purpose: Needs to be fixed at some point.

Comments

@singlis
Copy link
Member

singlis commented Mar 26, 2019

As part of our public API, we support the ability to filter out parts of the estimator chain. The APIs that support this are not documented, nor do we provide any context in our Cookbooks. As we are doing an overall coverage of documentation/samples, I created this issue separately to ensure that it gets covered. Referencing from #3063, these are the two APIs that are used:

public EstimatorChain<TNewTrans> Append<TNewTrans>(IEstimator<TNewTrans> estimator, TransformerScope scope = TransformerScope.Everything)

public TransformerChain<ITransformer> GetModelFor(TransformerScope scopeFilter)

It would also be very useful to have more information about why you would want to filter as well as what scenarios we are trying to address.

@singlis singlis added the documentation Related to documentation of ML.NET label Mar 26, 2019
@rauhs
Copy link
Contributor

rauhs commented Apr 30, 2019

Note: TransformerChain is still missing tons of docs. Should this be addressed before 1.0?

@shmoradims shmoradims added the P1 Priority of the issue for triage purpose: Needs to be fixed soon. label May 21, 2019
@frank-dong-ms-zz frank-dong-ms-zz added P2 Priority of the issue for triage purpose: Needs to be fixed at some point. and removed P1 Priority of the issue for triage purpose: Needs to be fixed soon. labels Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation of ML.NET P2 Priority of the issue for triage purpose: Needs to be fixed at some point.
Projects
None yet
Development

No branches or pull requests

4 participants