Skip to content

Commit

Permalink
Merge pull request #675 from dssg/fixing-little-dirtyduck
Browse files Browse the repository at this point in the history
Fixed broken links
  • Loading branch information
nanounanue authored Apr 21, 2019
2 parents ec78a2a + e7aea52 commit 067cd59
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 54 deletions.
22 changes: 11 additions & 11 deletions docs/sources/dirtyduck/docs/choose_your_own_adventure.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# How to use this tutorial?

- You are interested in the *learn* how to use `triage` and have a *lot* of time:
- [Infrastructure](02_infrastructure.md)
- [Data preparation](03_data_preparation.md)
- [Problem description](01_intro.md)
- [Resource prioritization](05_inspections.md)
- [Early warning systems](06_eis.md)
- [A deeper look into triage](04_triage_intro.md)
- [Scaling up](09_aws_batch.md)
- [Infrastructure](infrastructure.md)
- [Data preparation](data_preparation.md)
- [Problem description](intro.md)
- [Resource prioritization](inspections.md)
- [Early warning systems](eis.md)
- [A deeper look into triage](triage_intro.md)
- [Scaling up](aws_batch.md)
- You want to know about `triage`
- [A deeper look into triage](04_triage_intro.md)
- [A deeper look into triage](triage_intro.md)
- [Model governance](ml_governance.md)
- [Model selection](audition.md)
- You want to learn about case studies
- [Quick setup](07_quick_setup.md)
- [Resource prioritization](05_inspections.md) and/or [Early warning systems](06_eis.md)
- [Quick setup](for_the_impatient.md)
- [Resource prioritization](inspections.md) and/or [Early warning systems](eis.md)
- You *already* know `triage` but want to use it on the cloud
- [Scaling up](09_aws_batch.md)
- [Scaling up](aws_batch.md)
10 changes: 4 additions & 6 deletions docs/sources/dirtyduck/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This tutorial will show you how to use `triage`, a data science modeling tool developed at the [Center for Data Science and Public Policy](http://dsapp.uchicago.edu) (DSaPP) at the University of Chicago.

`triage` helps build models for three [common applied problems](https://dssg.uchicago.edu/data-science-for-social-good-conference-2017/training-workshop-data-science-for-social-good-problem-templates/): (a) Early warning systems (**EWS** or **EIS**), (b) *resource prioritization* (a.k.a "an inspections problem") and (c) interaction level predictions (a.k.a "appointment level"). These problems are difficult to model because their conceptualization and and implementation are prone to error, thanks to their multi-dimensional, multi-entity, time-series structure.

The last version of this tutorial is published in <https://dssg.github.io/dirtyduck/>
`triage` helps build models for two [common applied problems](https://dssg.uchicago.edu/data-science-for-social-good-conference-2017/training-workshop-data-science-for-social-good-problem-templates/): (a) Early warning systems (**EWS** or **EIS**), (b) *resource prioritization* (a.k.a "an inspections problem") . These problems are difficult to model because their conceptualization and and implementation are prone to error, thanks to their multi-dimensional, multi-entity, time-series structure.

**NOTE** This tutorial is in sync with the latest version of `triage`. At this moment [v3.3.0 (Arepa)](https://github.com/dssg/triage/releases/tag/v3.3.0).

Expand All @@ -25,9 +23,9 @@ At the moment only operative systems with \*nix-type command lines are supported

First, clone this repository on your laptop

git clone https://github.com/dssg/dirtyduck.git
git clone https://github.com/dssg/triage

Second, run
Second, in the `triage/docs/sources/dirtyduck/` directory run

./tutorial.sh start

Expand All @@ -36,4 +34,4 @@ This will take several minutes the first time you do it.

## How you can help to improve this tutorial

If you want to contribute, please follow the suggestions in the [README](file:///home/nanounanue/projects/dsapp/dirtyduck/README.md)
If you want to contribute, please follow the suggestions in the [README](../README.org)
2 changes: 1 addition & 1 deletion docs/sources/dirtyduck/docs/inspections.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Inpection prioritization
# Resource prioritization


## Problem description
Expand Down
14 changes: 5 additions & 9 deletions docs/sources/dirtyduck/org/00_instructions.org
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,13 @@ This tutorial will show you how to use =triage=, a data science
modeling tool developed at the [[http://dsapp.uchicago.edu][Center for Data Science and Public
Policy]] (DSaPP) at the University of Chicago.

=triage= helps build models for three [[https://dssg.uchicago.edu/data-science-for-social-good-conference-2017/training-workshop-data-science-for-social-good-problem-templates/][common applied problems]]: (a) Early
=triage= helps build models for two [[https://dssg.uchicago.edu/data-science-for-social-good-conference-2017/training-workshop-data-science-for-social-good-problem-templates/][common applied problems]]: (a) Early
warning systems (*EWS* or *EIS*), (b) /resource prioritization/ (a.k.a "an
inspections problem") and (c) interaction level predictions (a.k.a
"appointment level"). These problems
inspections problem") . These problems
are difficult to model because their conceptualization and
and implementation are prone to error, thanks to their multi-dimensional,
multi-entity, time-series structure.

The last version of this tutorial is published in [[https://dssg.github.io/dirtyduck/]]

*NOTE* This tutorial is in sync with the latest version of =triage=. At
this moment [[https://github.com/dssg/triage/releases/tag/v3.3.0][v3.3.0 (Arepa)]].

Expand All @@ -61,18 +58,17 @@ supported, such as =GNU/Linux= and =MacOS=. Recent versions of
First, clone this repository on your laptop

#+BEGIN_EXAMPLE
git clone https://github.com/dssg/dirtyduck.git
git clone https://github.com/dssg/triage
#+END_EXAMPLE

Second, run
Second, in the =triage/docs/sources/dirtyduck/= directory run

#+BEGIN_EXAMPLE
./tutorial.sh start
#+END_Example

This will take several minutes the first time you do it.


** How you can help to improve this tutorial

If you want to contribute, please follow the suggestions in the [[file:~/projects/dsapp/dirtyduck/README.org::*How%20you%20can%20help][README]]
If you want to contribute, please follow the suggestions in the [[../README.org][README]]
2 changes: 1 addition & 1 deletion docs/sources/dirtyduck/org/05_inspections.org
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#+EXPORT_FILE_NAME: ../docs/inspections.md
#+EXPORT_EXCLUDE_TAGS: noexport

* Inpection prioritization
* Resource prioritization
** Problem description

We will begin with the *inspection prioritization* problem. We want to generate a list of
Expand Down
22 changes: 11 additions & 11 deletions docs/sources/dirtyduck/org/choose_your_own_adventure.org
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@

- You are interested in the /learn/ how to use =triage= and have a /lot/ of
time:
- [[file:02_infrastructure.org][Infrastructure]]
- [[file:03_data_preparation.org][Data preparation]]
- [[file:01_intro.org][Problem description]]
- [[file:05_inspections.org][Resource prioritization]]
- [[file:06_eis.org][Early warning systems]]
- [[file:04_triage_intro.org][A deeper look into triage]]
- [[file:09_aws_batch.org][Scaling up]]
- [[file:infrastructure.md][Infrastructure]]
- [[file:data_preparation.md][Data preparation]]
- [[file:intro.md][Problem description]]
- [[file:inspections.md][Resource prioritization]]
- [[file:eis.md][Early warning systems]]
- [[file:triage_intro.md][A deeper look into triage]]
- [[file:aws_batch.md][Scaling up]]
- You want to know about =triage=
- [[file:04_triage_intro.org][A deeper look into triage]]
- [[file:triage_intro.md][A deeper look into triage]]
- [[file:ml_governance.org][Model governance]]
- [[file:audition.org][Model selection]]
- You want to learn about case studies
- [[file:07_quick_setup.org][Quick setup]]
- [[file:05_inspections.org][Resource prioritization]] and/or [[file:06_eis.org][Early warning systems]]
- [[file:for_the_impatient.md][Quick setup]]
- [[file:inspections.md][Resource prioritization]] and/or [[file:eis.md][Early warning systems]]
- You /already/ know =triage= but want to use it on the cloud
- [[file:09_aws_batch.org][Scaling up]]
- [[file:aws_batch.md][Scaling up]]
15 changes: 0 additions & 15 deletions manage.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,3 @@ def alembic(context, args):
'-x', 'db_config_file=database.yaml',
args.remainder,
]


@Development.register
class Docs(Local):

@local
def prepare_dirtyduck(context):
"""convert dirtyduck org files to markdown format"""
return context.local['emacs'][
'--batch',
'-l', 'org/publish.el', 'org/index.org',
'--eval', '(org-publish "dirtyduck" t)',
]

prepare_dirtyduck.__name__ = 'prepare-dirtyduck' # or whatever; I just find underscores weird in sh

0 comments on commit 067cd59

Please sign in to comment.