Skip to content

F# API Documentation Examples #3100

@singlis

Description

@singlis
Member

While our machinelearning-samples repo has F# samples, the ML.Net API documentation examples do not contain F# examples.

This is a work item to add F# examples to demonstrate API usage and to mirror what we have in C#.

Things that need to be understood:

  1. Does our current documentation pipeline support another language (we support python and C#, can we add F# examples and have it work or is there some additional work that needs to be done? If so, lets create an issue -- following up with @JRAlexander and @natke)

  2. If it is supported, is there a specific directory structure or other restrictions that need to be followed?

If there are sub-issues that need to be created, please use this as the global issue for tracking.

cc @shmoradims, @sfilipi, @zeahmed, @rogancarr

Activity

added
documentationRelated to documentation of ML.NET
F#Support of F# language
on Mar 26, 2019
added
P2Priority of the issue for triage purpose: Needs to be fixed at some point.
on May 21, 2019
charlesroddie

charlesroddie commented on Jul 20, 2019

@charlesroddie

It would be great if these samples don't use the reflection-based API as the current machinelearning-samples unfortunately do (example). I.e. they should use IDataView directly.

I believe the reflection-based annotated record approach doesn't suit F# because typical F# is a more type safe than typical C#, direct code is more typical than automatic tools, and there is less need to support non-programmer or semi-programmer data-scientists who can use the default C#.

Kavignon

Kavignon commented on Aug 25, 2019

@Kavignon

what kind of examples would you like to see in the F# documentation? I feel this issue would be a good start with ML.NET for me :)

added
P3Doc bugs, questions, minor issues, etc.
and removed
P2Priority of the issue for triage purpose: Needs to be fixed at some point.
on Jan 9, 2020
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

    F#Support of F# languageP3Doc bugs, questions, minor issues, etc.documentationRelated to documentation of ML.NET

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Kavignon@shmoradims@singlis@charlesroddie@antoniovs1029

        Issue actions

          F# API Documentation Examples · Issue #3100 · dotnet/machinelearning