7 ms·

The README could benefit from a description of what MLIR is.

by cratermoon 3y ago

kQq9oHeAz6wLLS 3y ago
My thought as well. Not exactly "for beginners" in a literal sense.
cabalamat 3y ago
This is true for most READMEs on github projects. Is it really too hard to write a paragraph giving the context?
mathisfun123 3y ago
i don't understand the point of this criticism - i swear people just post it because they don't know what the thing is and they feel they need to compulsively comment anyway. no one stumbles on this repo by accident (jeremy didn't post it here). the only way you find it is you google "mlir tutorial" ie you know what MLIR is and you're actively explicitly looking for a tut. there is no situation where you're ambushed by this content. like if i write a tutorial "integration by parts for beginners" but don't define integration are you gonna claim that it fails at being for beginners? does every title from now on need to explicitly have "... for beginners who know what this is and have already made the decision to start studying".
- noman-land 3y ago
  It's funny, I agree with both of you. Considering this repo was posted to this site and prompted thousands of people to stumble on it by accident, even a link in the README on the words "MLIR framework" would go a long way. I, as someone who is both super interested in applied FHE and subscribed to this guy's blog, almost skipped this post because I didn't realize it was about FHE, and I am probably in the target audience for it.
  - mathisfun123 3y ago
    > Considering this repo was posted to this site and prompted thousands of people to stumble on it by accident but the guy himself didn't post it. how are people so entitled that they're upset about a deficiency in a thing that they sought out. no one is making you go the repo (or asking you to go). it's literally like complaining about free samples at costco - if you don't like what they have don't take one!
    - noman-land 3y ago
      Taking the time out to post to complain that there's no info in a README is definitely not something I might choose to do, but if multiple people did it for my project, I might consider reflecting on the feedback and altering one line of README text to lower the friction of people checking out my project. The Costco example is perfect because if I was the sample manager or whatever and I overheard people rudely complaining to each other that they didn't like not knowing what was in the sample products, I might consider putting the ingredients list up next to the sample station. The goal is, after all, to get as many people to come check out the product as possible, right?
      - mathisfun123 3y ago
        > The goal is, after all, to get as many people to come check out the product as possible, right? the goal of this repo is to do something nice for people, not attract attention. i know that 100% if this was the reaction to my public service, i would immediately take the repo private because ungrateful people don't deserve to have nice things.
        noman-land 3y ago
        Is this not a tutorial made by a Google employee in the duties of their employment?
        mathisfun123 3y ago
        Of course not. Do you see Google mentioned anywhere?

The README could benefit from a description of what MLIR is.

kQq9oHeAz6wLLS 3y ago

My thought as well. Not exactly "for beginners" in a literal sense.

cabalamat 3y ago

This is true for most READMEs on github projects. Is it really too hard to write a paragraph giving the context?

mathisfun123 3y ago

i don't understand the point of this criticism - i swear people just post it because they don't know what the thing is and they feel they need to compulsively comment anyway. no one stumbles on this repo by accident (jeremy didn't post it here). the only way you find it is you google "mlir tutorial" ie you know what MLIR is and you're actively explicitly looking for a tut. there is no situation where you're ambushed by this content. like if i write a tutorial "integration by parts for beginners" but don't define integration are you gonna claim that it fails at being for beginners? does every title from now on need to explicitly have "... for beginners who know what this is and have already made the decision to start studying".

noman-land 3y ago
It's funny, I agree with both of you. Considering this repo was posted to this site and prompted thousands of people to stumble on it by accident, even a link in the README on the words "MLIR framework" would go a long way. I, as someone who is both super interested in applied FHE and subscribed to this guy's blog, almost skipped this post because I didn't realize it was about FHE, and I am probably in the target audience for it.
- mathisfun123 3y ago
  > Considering this repo was posted to this site and prompted thousands of people to stumble on it by accident but the guy himself didn't post it. how are people so entitled that they're upset about a deficiency in a thing that they sought out. no one is making you go the repo (or asking you to go). it's literally like complaining about free samples at costco - if you don't like what they have don't take one!
  - noman-land 3y ago
    Taking the time out to post to complain that there's no info in a README is definitely not something I might choose to do, but if multiple people did it for my project, I might consider reflecting on the feedback and altering one line of README text to lower the friction of people checking out my project. The Costco example is perfect because if I was the sample manager or whatever and I overheard people rudely complaining to each other that they didn't like not knowing what was in the sample products, I might consider putting the ingredients list up next to the sample station. The goal is, after all, to get as many people to come check out the product as possible, right?
    - mathisfun123 3y ago
      > The goal is, after all, to get as many people to come check out the product as possible, right? the goal of this repo is to do something nice for people, not attract attention. i know that 100% if this was the reaction to my public service, i would immediately take the repo private because ungrateful people don't deserve to have nice things.
      - noman-land 3y ago
        Is this not a tutorial made by a Google employee in the duties of their employment?
        mathisfun123 3y ago
        Of course not. Do you see Google mentioned anywhere?