Skip to content
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

Mathmatical operation needs mathmatical equations for documentation #3439

Open
wschin opened this issue Apr 19, 2019 · 0 comments
Open

Mathmatical operation needs mathmatical equations for documentation #3439

wschin opened this issue Apr 19, 2019 · 0 comments
Labels
documentation Related to documentation of ML.NET P2 Priority of the issue for triage purpose: Needs to be fixed at some point.

Comments

@wschin
Copy link
Member

wschin commented Apr 19, 2019

I feel we should follow Pytorch to add equations to APIs --- for example, https://pytorch.org/docs/stable/nn.html#torch.nn.Conv1d. I personally believe that is how a math library's documentation should look like. Also, debugging ML models is quite different from debugging typical code --- debugging ML model (such as figuring why it doesn't work) requires knowledge of the underlying mathematical models.

@wschin wschin changed the title Math mathmatical operation needs mathmatical equations for documentation Mathmatical operation needs mathmatical equations for documentation Apr 19, 2019
@shmoradims shmoradims added the documentation Related to documentation of ML.NET label Apr 19, 2019
@shmoradims shmoradims added the P2 Priority of the issue for triage purpose: Needs to be fixed at some point. label May 21, 2019
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

2 participants