Publish Repository - Githubissues

Simsso / NIPS-2018-Adversarial-Vision-Challenge

Code, documents, and deployment configuration files, related to our participation in the 2018 NIPS Adversarial Vision Challenge "Robust Model Track"

MIT License

10 stars 1 forks source link

Publish Repository #83

Closed Simsso closed 5 years ago

Simsso commented 5 years ago

As discussed, we plan to make the repository public once the challenge is over.

Before we do that we should update the readme files, maybe add some more information about the team, and other stuff (@doktorgibson, @FlorianPfisterer please use this issue to name ideas).

FlorianPfisterer commented 5 years ago

Let's think about:

Which parts of the code might be useful for someone to re-use?
What are the most interesting findings / parts of code / "nuggets" 🎁 for someone who explores the repository?
What were our individual major contributions?
Maybe do a recap of how we started, which directions we chose to look into and where we ended up and which decisions we made along the way (and why).
Does it make sense to continue the development of some of our ideas (i.e. allow contributions)?

Then we can adjust our README's accordingly, looking at it from the perspective of someone who finds our repository and is evaluating if there's something of value for them to be found in it.

ghost commented 5 years ago

Some additional things from my side:

split README in multiple parts for example: (0) Short Summary (max. 3-4 Sentences) (1) Goal (NIPS Challenge) (2) Motivation (3) Setup (e.g. use of ALP weights) (4) Approaches (vq, PCA etc.) (5) Results (hoping for breakthrough here) (7) Structure of Repository (8) Our Training Pipeline (9) Next Steps (Everything involving future ideas, contributions etc.) (10) About the Contributors

Those point should be kept short as possible. The corresponding wikipages should be used to delve more profoundly into the specific topic.

Edit: We should also loose some words about our project management such as Working Group Meetings, Issues, PR etc. Because this was one of the best things I could experience in a project.

FlorianPfisterer commented 5 years ago

Another ToDo: