Would you say the same about an experimental programming language based on a bunch of recent PLT/CS research?
That's pretty much what this is, but for machine learning. It's not meant to be "for the public", it's effectively research.
Would you say the same about an experimental programming language based on a bunch of recent PLT/CS research?
That's pretty much what this is, but for machine learning. It's not meant to be "for the public", it's effectively research.
A researcher releasing work publicly on github is presumably doing so too spread the ideas.
Sharing a link on Hacker News is effectively taking it out of context and sometimes it's up to us to add that context back in. The author doesn't owe it to us.
There are like 6 different definitions of what a "transformer" is and none of them fall under "machine learning". If you have a README, then that implies its intended for others to read, and so it should be made with that in mind. If I happened to be interested in machine learning, this would be a project that I would bookmark for further use -- except I wouldn't know to bookmark it because they didn't bother to include a total of two words ("machine learning") that give context of how to parse the word "transformer".
The fact that the owner didn't provide that context is not excused by the fact that the repository owner decided to implement a handful of research papers. It absolutely is the responsibility of the authors of projects, and the authors of README files, to provide context about what something does. The entire point of the README is to clear up ambiguity about what something is. You might as well say, why not include a README? People who are using the project know well enough how to run it!
Paid products, public releases, etc. are different and are treated differently.
From me? Or are you lumping me in with all the "nay-sayers", despite the fact that I'm trying to offer criticism of a problem that's pretty common in computer science and outside it?
There is always context and sometimes you don’t have it. Do you expect everything to be written in English for your benefit?
But sure, it would be nice to clarify things for random passers-by so they know it’s not the droid they’re looking for. It’s just not required to do this in every Github repo.
I'm not even sure what you mean to say here. Is asking that the README contain a single two letter phrase reference to the subject matter, the same as expecting the entirety of the world to be written in english?
Quite literally all I've stated is that if you're making something that's clearly intended to be public-facing, it's worth taking the exact ½ of a second to allow people who can't read your mind to understand what context they should read something in?
You seem not to understand that people have different comprehension levels and the one you’re in isn’t necessary the most important one to the author.
I disagree, it would be enough for a non-technical audience, since it would give enough information for them to do *research* and find out more information.
I personally disagree that volunteers owe you anything at all, much less a README, and that we should be thankful for all they do to help as is.
But for real, go post an issue! not trying to play devil's advocate, honestly! Your voice is not heard when complaining anywhere but the repository itself this is open source software and everyone should have a voice!
Some of lucidrains other projects include the line "This is an implementation of thing with link" which I feel you'd prefer.
Like others, I too encourage you to open an issue to do the same here instead of leaving it till "after the fold".