README.md does not say what WASI-nn is

WebAssembly / wasi-nn

Neural Network proposal for WASI

448 stars 35 forks source link

README.md does not say what WASI-nn is #7

Closed prescod closed 3 years ago

prescod commented 3 years ago

The README.md does not say what WASI-nn is.

abrown commented 3 years ago

Yeah, that is a bit confusing. The general process for proposals to WASI is to fork the main repository, make changes, and eventually merge them back in. If we add any wasi-nn specific text to the README we will have to remove it before merging; since that will probably take quite some time, I don't see an issue with adding a small descriptive paragraph. Or are you looking for a more in-depth explanation? This blog post might give more details.

prescod commented 3 years ago

I agree that a small descriptive paragraph would be a good idea and you could link to the blog post as well.

There is already a "diff" at the top of the README so it doesn't make much difference if it is one sentence or 10 paragraphs. Deleting it consists of highlighe/delete/commit either way.

Arguably making it bigger reduces the likelihood of you accidentally leaving it during the merge.