Skip to content

SamplesUtils is not searchable on doc site and makes ML.NET learning curve sharp #2794

Closed

Description

@wschin

We use SamplesUtils project in many examples. However, its functions and classes cannot be found in ML.NET's official doc site. This is not ideal because once a user has a question regarding SamplesUtils when learning our API examples, they will be blocked until they clones ML.NET or finds the right nuget package. This makes the learning curve of ML.NET very sharp. Also, please do not expect users have Visual Studio installed, so finding the right solution can be even more painful.

Activity

  1. changed the title [-]SamplesUtils is not searchable on doc site[/-] [+]SamplesUtils is not searchable on doc site and makes ML.NET learning curve sharp[/+] on Feb 28, 2019
  2. rogancarr commented on Mar 1, 2019

    @rogancarr
    Contributor

    @CESARDELATORRE @JRAlexander

    I think we need clarification on how we should be formatting docs samples in this project, and what the relationship between the documentation samples and the samples.

    Questions:

    1. Should the samples included in the API docs be stand-alone, full length programs?
    2. Should the samples included in the API docs be searchable on the docs site and live in their own section?

    Related to #2726

  3. shmoradims commented on Mar 1, 2019

    @shmoradims

    I checked with Wei-Sheng and the APIs are searchable in API search.

    @rogancarr let's discuss your question 1 above in #2726.

    For question 2, please note that this issue was not about the sample code being searchable, but SamplesUtils namespace and it's utility classes being searchable. Sample code is not part of ML.NET API, so it's not searchable through API search.

  4. added a commit that references this issue on Mar 11, 2021
  5. ghost locked as resolved and limited conversation to collaborators on Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelated to documentation of ML.NET

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions