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

Release #138

Merged
merged 43 commits into from
Jul 15, 2019
Merged

Release #138

merged 43 commits into from
Jul 15, 2019

Conversation

AleksandarZeljic
Copy link
Collaborator

@AleksandarZeljic AleksandarZeljic commented Jun 3, 2019

First draft of a README file. Coding guidelines and Developer's guide are uploaded directly to the wiki, please check those too!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Rules.mk Outdated Show resolved Hide resolved
@AleksandarZeljic AleksandarZeljic changed the title Rewrite README Release Jul 8, 2019
@@ -1,3 +1,117 @@
# Marabou

Marabou is tested on Ubuntu and macOS.
Marabou supports fully connected feed-forward and convolutional NNs with
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's add a paragraph or two with some context:

  1. Motivate need for formal analysis of neural networks
  2. Define the verification problem for neural networks
  3. Explain that Marabou is a tool for solving this problem
    You can probably grab some text from the tool paper.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've merged abstract and parts of introduction to cover the points raised.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Collaborator

@barrettcw barrettcw left a comment

Choose a reason for hiding this comment

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

Looks good

@guykatzz guykatzz merged commit 30bd4aa into NeuralNetworkVerification:master Jul 15, 2019
matanost pushed a commit that referenced this pull request Nov 2, 2021
* Rewrite README

* PR Feedback

* Tweaks

* Add some links, fixed review comments.

* Added nnet files.

* Add Property files

* Update experiments README

* Update README with link locations (broken atm)

* Rename ACAS benchmarks

* Update README - links and some people

* Updates to README

* Rename ReluplexError to MarabouError

* Update People section in README.md

* Rename ReluplexError after merge + merge fix

* Add DNC mode instructions + minor fixes

* Rename experiments to resources

* Merge of "release" and "origin/release"

Fix -static that wandered into the makefile

* Add simple --help

* Add simple --help

* Add simple --help

* Revert -static in Makefile

* Add help message and version printout

* Updated --help and --version

* Update acknowledgements

* Updated export paths

* Removed files that are outdated

* Add DnC demo

* Remove incomplete/unaccompanied files

* Cleaned up the Example notebook

* Add links to paper pre-print and slides

* Clean up text/typos

* Add motivation and context for verification of DNNs

* Removed leftover code --help code

* Add pybind11 dependency to maraboupy

* Typos

* Updated slides link
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