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

SIMD docs #12660

Closed
FIVIL opened this issue Jun 4, 2019 · 8 comments · Fixed by #13262
Closed

SIMD docs #12660

FIVIL opened this issue Jun 4, 2019 · 8 comments · Fixed by #13262
Assignees
Labels
doc-enhancement Improve the current content [org][type][category] doc-idea Indicates issues that are suggestions for new topics [org][type][category]
Milestone

Comments

@FIVIL
Copy link
Contributor

FIVIL commented Jun 4, 2019

I recently used SIMD capabilities of .net and I find it fascinating, however, the official documentation seems lagging in this regard -the only thing I could find is this Numerics in .NET which is not complete- so I wanted to create a complete SIMD documentation.
my proposed outline contains:

  1. What is SIMD
  2. How we can use SIMD in .net
  3. Caution and don'ts of SIMD
  4. Maybe some benchmarks at the end

also, I did some docs contribution to .Net foundation projects not long ago, and I'm fairly familiar with the process.
dotnet/AspNetCore.Docs#11770
dotnet/AspNetCore.Docs#12108
dotnet/AspNetCore.Docs#12137

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Jun 4, 2019
@rpetrusha
Copy link
Contributor

Thanks you, @FIVIL, for offering to provide some solid information on SIMD. We'd welcome your contribution, and your basic outline looks good. How would you like to proceed, and what sort of time frame are you looking at for submitting a PR?

@terrajobst, do you have any feedback about more detailed SIMD content?

@rpetrusha rpetrusha added this to the Backlog milestone Jun 5, 2019
@terrajobst
Copy link
Member

terrajobst commented Jun 5, 2019

@tannergooding would be the best person to provide feedback on this because he's been working heavily on all the intrinsics lately. We should probably talk about SIMD in general and then how we're exposing in the the BCL, as an abstraction (Vector<T>) and as a set processor instructions in System.Runtime.Intrinsics.

I like the idea of dos and dont's but that's definitely @tannergooding territory.

@tannergooding
Copy link
Member

Adding conceptual docs for hardware intrinsics is on my list of backlog items to do for 3.0. However, I would be very happy if someone else wanted to start that work and would be happy to review and provide input as appropriate 😄

Also CC. @danmosemsft

@rpetrusha
Copy link
Contributor

Thanks, @tannergooding. Does the rough outline that @FIVIL provided sound good, with the possible addition of a section on SIMD and the underlying hardware?

@tannergooding
Copy link
Member

Yes, the four sections listed look to cover what I would expect.

@FIVIL
Copy link
Contributor Author

FIVIL commented Jun 6, 2019

@rpetrusha , I'm planning to get the best of my free time by providing this tutorial, so I think maybe I can deliver it in a month or so, hope that's Ok, and after that, I'll be open to any note and comment and change needed in order to finalize it. and also I think the best way to do this will be 2 separate articles the first one containing a simple definition and instruction and some simple code samples for starters. and the second article will be a deep dive into the concept of SIMD, underlying hardware, CPU, capabilities and the best practices for SIMD with some insights and of course, some benchmarks to demonstrate benefits of using SIMD.
I will /cc you in the PRs.

@FIVIL
Copy link
Contributor Author

FIVIL commented Jun 6, 2019

@tannergooding and @terrajobst tnx for your insights.
also, I might need to ask some questions about some concepts during the process if that's OK.

@Thraka Thraka added the doc-idea Indicates issues that are suggestions for new topics [org][type][category] label Jun 6, 2019
@rpetrusha
Copy link
Contributor

That sounds good, @FIVIL. We'll look forward to reviewing your PR in about a month.

@FIVIL FIVIL mentioned this issue Jul 6, 2019
@tdykstra tdykstra added doc-enhancement Improve the current content [org][type][category] P2 labels Oct 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] doc-idea Indicates issues that are suggestions for new topics [org][type][category]
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants