Register a SA Forums Account here!
JOINING THE SA FORUMS WILL REMOVE THIS BIG AD, THE ANNOYING UNDERLINED ADS, AND STUPID INTERSTITIAL ADS!!!

You can: log in, read the tech support FAQ, or request your lost password. This dumb message (and those ads) will appear on every screen until you register! Get rid of this crap by registering your own SA Forums Account and joining roughly 150,000 Goons, for the one-time price of $9.95! We charge money because it costs us money per month for bills, and since we don't believe in showing ads to our users, we try to make the money back through forum registrations.
 
  • Post
  • Reply
flappin fish
Jul 4, 2005

Xun posted:

When you look at a GitHub page for a research paper, what do you guys want to see if the readme? Im updating mine for a publication and sadly the only advice I'm getting from my labmates is "the code is all there and there's a bibtex citation, why are you worrying :confused:"

Honestly I'm usually pretty happy with just "type this to run model" but idk if that's the norm lol

You'd think this would be a basic one (who wouldn't include a requirements.txt?) but please please please list all required libraries and versions. It takes long enough to get research code running as it is. I spent a couple of days once because someone's requirements.txt didn't list library versions and it depended on old versions that weren't easily interoperable.

It's nice if "type this to run model" replicates exactly what was done in the paper.

Also, please stick a license on your code.

Adbot
ADBOT LOVES YOU

  • 1
  • 2
  • 3
  • 4
  • 5
  • Post
  • Reply