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 Audit Algorithms #2023

Merged
merged 1 commit into from
Jun 2, 2022
Merged

Conversation

erwanlemerrer
Copy link
Contributor

[Insert URL to the list here]
https://github.com/erwanlemerrer/awesome-audit-algorithms

[Explain what this list is about and why it should be included here]
A curated list of audit algorithms for getting insights from black-box algorithms.

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. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • 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
    • 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.
  • The default branch should be named main, not master.
  • 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.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • 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 use hard-wrapping.
  • 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.

@erwanlemerrer
Copy link
Contributor Author

Hello,
Commented on PRs #2001.
Commented on PRs #2020.
unicorn

Copy link
Contributor

@pgray-hiro pgray-hiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @erwanlemerrer, from looking at other PRs, I think your unicorn comment needs to be stand-alone. Additionally, I think you need to put your reviewed PRs in the description of the PR.

Looking at your list, it does not follow the format of other awesome lists. I would suggest removing the table format, and moving all of the links into the preferred list format. Although it does pass the linter, I believe that the list is not in the spirit of other lists on this page.

Additionally, this list doesn't include anything more than academic papers. It would be nice to include links to implementations in code, projects using these algorithms, and other online resources.

@erwanlemerrer
Copy link
Contributor Author

@sindresorhus Hi, what can I do to support this PR please ?

@sindresorhus
Copy link
Owner

I think it would be useful if the list had a little bit more verbose description about the topic. I'm talking about this part: "A curated list of audit algorithms for getting insights from black-box algorithms.".


I think the description column should come right after the title columns.


I find the use of table makes the list harder to read and scan than a plain list and it's also harder to contribute to.

@sindresorhus
Copy link
Owner

It would be nice to include links to implementations in code, projects using these algorithms, and other online resources.

👍

@m8
Copy link

m8 commented Aug 19, 2021

Also it would be nice to categorize these papers. It would be more easier to explore

@m8 m8 mentioned this pull request Sep 10, 2021
@sindresorhus
Copy link
Owner

Bump

@erwanlemerrer
Copy link
Contributor Author

@sindresorhus would that simple format more suitable ?

https://github.com/aliyesilkanat/awesome-audit-algorithms

thanks (will then add the larger description you called for)

@sindresorhus
Copy link
Owner

sindresorhus commented Jan 23, 2022

would that simple format more suitable ?

Yes, but they should still include descriptions.

@erwanlemerrer
Copy link
Contributor Author

Yes, but they should still include descriptions.

@sindresorhus Done as asked. Thanks

@sindresorhus
Copy link
Owner

❯ awesome-lint https://github.com/erwanlemerrer/awesome-audit-algorithms
✖ Linting

  README.md:4:70
  ✖   4:70   Should not repeat "."                                         remark-lint:no-repeat-punctuation
  ✖   4:71   Should not repeat "."                                         remark-lint:no-repeat-punctuation
  ✖  15:86   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  16:240  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  20:92   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  21:75   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  22:213  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  23:201  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  24:160  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  25:131  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  26:90   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  28:108  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  29:100  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  30:113  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  31:107  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  32:198  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  33:102  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  34:128  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  35:145  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  36:131  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  38:92   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  39:153  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  40:98   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  41:97   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  42:127  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  43:92   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  44:124  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  45:147  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  47:150  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  48:119  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  49:111  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  50:101  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  52:117  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  53:148  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  54:114  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  55:126  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  56:154  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  58:81   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  60:109  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  62:88   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  64:108  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  66:138  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  68:69   List item link and description must be separated with a dash  remark-lint:awesome-list-item

  43 errors

https://github.com/sindresorhus/awesome-lint

@sindresorhus
Copy link
Owner

Make sure the list follows all the guidelines.

@erwanlemerrer
Copy link
Contributor Author

Make sure the list follows all the guidelines.

Indeed, now lint passed fine, sorry about that.

@erwanlemerrer
Copy link
Contributor Author

@sindresorhus anything else I can do that could help?

@sindresorhus sindresorhus merged commit 978f08a into sindresorhus:main Jun 2, 2022
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1532319830350520320

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.

5 participants