fixed merge conflicts, updated readme

Author: Berk Ustun

README.md

@@ -1,21 +1,11 @@
 risk-slim
 ========
 
-`risk-slim` is a machine learning method to fit simple customized risk scores in python. 
+risk-slim is a machine learning method to fit simple customized risk scores in python. 
 
-### Background 
+#### Background 
 
-Risk scores are simple tools that let users make quick risk predictions by adding and subtracting a few small numbers (see e.g., 500 + medical risk scores at [mdcalc.com](https://www.mdcalc.com/) and the [mdcalc iOS app](https://itunes.apple.com/us/app/mdcalc-medical-calculators-clinical-scores/id1001640662?ls=1&mt=8)).
-
-#### Video
-
-<p align="center">
-	<a href="http://www.youtube.com/watch?feature=player_embedded&v=WQDVejk17Aw" target="_blank">
-		<img src="http://img.youtube.com/vi/WQDVejk17Aw/0.jpg" alt="RiskSLIM KDD" width="480" height="360" border="10" />
-	</a>
-</p>
-
-#### Customized Risk Score for ICU Seizure Prediction 
+Risk scores let users make quick risk predictions by adding and subtracting a few small numbers (see e.g., 500 + medical risk scores at [mdcalc.com](https://www.mdcalc.com/)). 
 
 Here is a risk score for ICU risk prediction from our [paper](http://www.berkustun.com/docs/ustun_2017_optimized_risk_scores.pdf). 
 
@@ -25,15 +15,23 @@ Here is a risk score for ICU risk prediction from our [paper](http://www.berkust
 </p>
 </div>
 
-#### References 
+#### Video
 
-If you use ``risk-slim`` for in your research, please cite our paper!
+<p align="center">
+	<a href="http://www.youtube.com/watch?feature=player_embedded&v=WQDVejk17Aw" target="_blank">
+		<img src="http://img.youtube.com/vi/WQDVejk17Aw/0.jpg" alt="RiskSLIM KDD" width="480" height="360" border="10" />
+	</a>
+</p>
+ 
+
+#### Reference
+
+If you use risk-slim in your research, please cite our paper!
 
 <a href="http://jmlr.org/papers/v20/18-615.html" target="_blank">Learning Optimized Risk Scores</a> <br>
 Berk Ustun and Cynthia Rudin<br>
-Journal of Machine Learning Research (JMLR), 2019.
+Journal of Machine Learning Research, 2019.
 
-     
 ```
 @article{ustun2019jmlr,
   author  = {Ustun, Berk and Rudin, Cynthia},
@@ -47,44 +45,40 @@ Journal of Machine Learning Research (JMLR), 2019.
 }
 ```
 
-## Package Details
+## Installation
 
-**NOTE: THIS PACKAGE IS CURRENTLY UNDER DEVELOPMENT. THE API MAY CHANGE WITH EACH COMMIT.** 
+risk-slim requires Python 3.5+ and CPLEX 12.6+.
 
-### Installation
-  
-Run the following snippet to install ``risk-slim`` in a Mac/Unix environment, and complete a test run.  
+### Quick Install
+
+Run the following snippet in a Unix terminal to install risk-slim and complete a test run.  
 
 ```
 git clone https://github.com/ustunb/risk-slim
 cd risk-slim
-pip install -e . #install in editable mode  
-bash batch/job_template.sh #batch run
+pip install -e . 		# install in editable mode  
+bash batch/job_template.sh 	# batch run
 ```
 
-### Requirements
-
-- Python 3.5+ 
-- CPLEX 12.6+
- 
-The code may still work with older versions of Python and CPLEX, but this will not be tested or supported. If you're hesitant about switching to Python 3, check out this [migration guide](https://github.com/arogozhnikov/python3_with_pleasure) 
+### CPLEX
 
-#### CPLEX 
-
-CPLEX is cross-platform optimization tool solver a Python API. It is free for students and faculty members at accredited institutions. To get CPLEX:
+CPLEX is cross-platform optimization tool solver a Python API. It is free for students and faculty members at accredited institutions. To download CPLEX:
 
 1. Register for [IBM OnTheHub](https://ibm.onthehub.com/WebStore/Account/VerifyEmailDomain.aspx)
 2. Download the *IBM ILOG CPLEX Optimization Studio* from the [software catalog](https://ibm.onthehub.com/WebStore/ProductSearchOfferingList.aspx?srch=CPLEX)
-3. Install the CPLEX Optimization Studio.
+3. Install CPLEX Optimization Studio.
 4. Setup the CPLEX Python API [as described here](https://www.ibm.com/support/knowledgecenter/SSSA5P_12.8.0/ilog.odms.cplex.help/CPLEX/GettingStarted/topics/set_up/Python_setup.html).
 
-If you have problems installing CPLEX, check the [CPLEX user manual](http://www-01.ibm.com/support/knowledgecenter/SSSA5P/welcome) or the [CPLEX forums](https://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002059). 
+If you have problems with CPLEX, please check the [CPLEX user manual](http://www-01.ibm.com/support/knowledgecenter/SSSA5P/welcome) or the [CPLEX forums](https://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002059). 
+
+## Contributing
 
-## Development Roadmap
+I'm planning to pick up development again in Fall 2020. I can definitely use a hand! If you are interested in contributing, please reach out to [[email protected]](mailto:[email protected])! 
 
-**If you are interested in contributing, please reach out!**
+Here's the current development roadmap:
 
-- [sci-kit learn interface](http://scikit-learn.org/stable/developers/contributing.html#rolling-your-own-estimator) API
-- support for open source solver
+- [sci-kit learn interface](http://scikit-learn.org/stable/developers/contributing.html#rolling-your-own-estimator)
+- support for open source solver and Gurobi via [python-mip](https://github.com/coin-or/python-mip)
 - reporting tools (roc curves, calibration plots, model reports)
-- documentation
+- documentation
+- pip