Skip to content

F# API Documentation Examples #3100

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 · 2 comments
Open

F# API Documentation Examples #3100

singlis opened this issue Mar 26, 2019 · 2 comments
Labels
documentation Related to documentation of ML.NET F# Support of F# language P3 Doc bugs, questions, minor issues, etc.

Comments

@singlis
Copy link
Member

singlis commented Mar 26, 2019

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

@singlis singlis added documentation Related to documentation of ML.NET F# Support of F# language labels Mar 26, 2019
@shmoradims shmoradims added the P2 Priority of the issue for triage purpose: Needs to be fixed at some point. label May 21, 2019
@charlesroddie
Copy link

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
Copy link

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 :)

@antoniovs1029 antoniovs1029 added P3 Doc bugs, questions, minor issues, etc. and removed P2 Priority of the issue for triage purpose: Needs to be fixed at some point. 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 F# Support of F# language P3 Doc bugs, questions, minor issues, etc.
Projects
None yet
Development

No branches or pull requests

5 participants