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

Add Machine Learning Interpretability #1644

Closed
wants to merge 1 commit into from

Conversation

matheusgmaia
Copy link

@matheusgmaia matheusgmaia commented Oct 26, 2019

https://github.com/jphall663/awesome-machine-learning-interpretability

A curated list of awesome machine learning interpretability resources.

PRs Reviewed:
PR1643
PR1641

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.

  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration.

  • You have read and understood the instructions for creating a list.

  • This pull request has a title in the format Add Name of List.

    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.

    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.

  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • If you use a license badge, it should be SVG, not PNG.
    • To verify that you've read all the guidelines, please add comment with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

Add awesome-machine-learning-interpretability
@matheusgmaia
Copy link
Author

unicorn

@vinibeloni
Copy link

For me, its okay. Thanks for contribution!

@vinibeloni vinibeloni mentioned this pull request Oct 28, 2019
@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@sindresorhus
Copy link
Owner

For me, its okay. Thanks for contribution!

@vinibeloni Please do a better effort when reviewing. This is very far from following the guidelines.

@willeastcott
Copy link
Contributor

Hi @matheusgmaia. Here are some pointers for things you might want to address if you want your PR to be merged:

  • The heading title of your list should be in title case format: # Awesome Name of List.
    ✅ Awesome Machine Learning Interpretability
    ❌ awesome-machine-learning-interpretability
  • Includes a project logo/illustration whenever possible (for your list, there may not be an image though).
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.

Also, consider sticking to the following format for link items:

Link - Description.

Often, you just have long descriptive links or links with no description.

@willeastcott willeastcott mentioned this pull request Oct 28, 2019
@matheusgmaia
Copy link
Author

Thanks for the feedback.

@maehr
Copy link
Contributor

maehr commented Oct 29, 2019

Hi @matheusgmaia

Thanks a lot for this list.

I recommend you use awesome-lint. It points to these shortcomings of your draft.

  README.md:160:3
  ✖    1:1    Main heading must be in title case                                                                                 remark-lint:awesome/heading
  ✖    1:1    Missing License section                                                                                            remark-lint:awesome/license
  ✖    1:1    Missing or invalid Table of Contents                                                                               remark-lint:awesome/toc
  ✖    1:48   Invalid badge source                                                                                               remark-lint:awesome/badge
  ✖    9:67   Text "github" should be written as "GitHub"                                                                        remark-lint:awesome/spell-check
  ✖   64:3    Invalid list item link URL                                                                                         remark-lint:awesome/list-item
  ✖  143:4    Text "Youtube" should be written as "YouTube"                                                                      remark-lint:awesome/spell-check
  ✖  146:109  List item link and description must be separated with a dash                                                       remark-lint:awesome/list-item
  ✖  148:3    Link to https://www.algoaware.eu/ is dead                                                                          remark-lint:no-dead-urls
  ✖  160:3    Link to https://www.oreilly.com/ideas/you-created-a-machine-learning-application-now-make-sure-its-secure is dead  remark-lint:no-dead-urls
  ✖  207:80   List item link and description must be separated with a dash                                                       remark-lint:awesome/list-item
  ✖  231:80   List item link and description must be separated with a dash                                                       remark-lint:awesome/list-item

  12 errors

@zmedelis
Copy link
Contributor

This is not explicitly in contribution guidelines but under Python section you have links to zip files

* [Bayesian Case Model](https://users.cs.duke.edu/~cynthia/code/BCM.zip)
* [Bayesian Rule List (BRL)](https://users.cs.duke.edu/~cynthia/code/BRL_supplement_code.zip)
* [Falling Rule List (FRL)](https://users.cs.duke.edu/~cynthia/code/falling_rule_list.zip)

Items should link to a project/product pages with some descriptions and docs. If you need to have the above links maybe its better to point to the home page (first link 'Bayesian Case Model' case) https://users.cs.duke.edu/~cynthia/code.html at least it as a reference to an academic paper.

@sindresorhus
Copy link
Owner

@matheusgmaia Bump

@GustavBertram
Copy link
Contributor

@matheusgmaia You should make a PR to fix the issues, as requested by @jphall663 here: jphall663/awesome-machine-learning-interpretability#23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants