Repo readme #682

thcrock · 2019-05-03T22:02:04Z

No description provided.

thcrock · 2019-05-03T22:12:37Z

I created this as a draft because the way I implemented the auto-README -> docs page copy won't work with how our travis github pages integration is implemented. However, the actual content is ready for review.

shaycrk · 2019-06-11T20:02:31Z

README.md

+
+`Experiment` (create features and models) -> `Audition` (pick the best models) -> `Postmodeling` (dive into best models)
+
+## Documentation Quick Links


maybe just a quick sentence about what each of these is (e.g., "Start here if you want...")?

shaycrk · 2019-06-11T20:10:06Z

README.md

+installed directly using `easy_install` or `pip` (`pip install triage`), or named as a
+dependency of another package as `triage`.
+
+### Design an Experiment


Maybe briefly describe what an experiment is in terms of triage (and maybe why we call it that) since it's not necessarily familiar/standard terminology.

Since we kind of do this later, perhaps it makes sense to move 'Triage Phase Details' up before this part? Or even just stick this section into the 'Experiment' part of the aforementioned 'Triage Phase Details'?

shaycrk · 2019-06-11T20:12:40Z

README.md

+To use Triage, you first need:
+
+- Python 3.6
+- A PostgreSQL database with your source data (events, geographical data, etc) loaded.


Do we have a sense of the minimum version requirement for postgres?

shaycrk · 2019-06-11T20:16:30Z

README.md

+tasks, such as feature generation, classifier training, evaluation, and
+list generation. These tasks are complicated in their own right, but in
+addition have to be combined in different ways throughout the course of
+the project.


I feel like somewhere here we should mention the focus on problems with a time component. I don't think Triage would work without any sort of temporal config, at least as it's currently built, would it?

shaycrk · 2019-06-11T20:17:03Z

README.md

+experiment = SingleThreadedExperiment(
+    config=experiment_config, # a dictionary
+    db_engine=create_engine(...), # http://docs.sqlalchemy.org/en/latest/core/engines.html
+    project_path='/path/to/directory/to/save/data'


(maybe add a comment that this can be in S3?)

shaycrk · 2019-06-11T20:19:27Z

README.md

+
+If you're new to Triage Experiments, check out the [Dirty Duck tutorial](https://dssg.github.io/dirtyduck). It's a guided tour through Triage functionality using a real-world problem.
+
+If you're familiar with creating an Experiment but want to see more reference documentation and some deep dives, check out the links on the side.


"links on the side" in dirty duck?

shaycrk · 2019-06-13T22:23:56Z

README.md

+dependency of another package as `triage`.
+
+
+## Experiment


maybe make this header: Experiment: Create features and Models

shaycrk · 2019-06-13T22:24:24Z

README.md

+
+If you're familiar with creating an Experiment but want to see more reference documentation and some deep dives, the [Triage Documentation Site](https://dssg.github.io/triage) has more content.
+
+## Audition


maybe: Audition: Pick the Best Models

shaycrk · 2019-06-13T22:25:16Z

README.md

+
+To get started with Audition, check out its [README](https://github.com/dssg/triage/tree/master/src/triage/component/audition)
+
+## Postmodeling


maybe: Postmodeling: Dive Deeper into Selected Models

shaycrk · 2019-06-13T22:27:42Z

made a couple suggestions on the headers and might even consider numbering them ("0. Prerequisites", "1. Install", etc) unless that seems like too much? Just trying to make the flow of the pipeline super-clear at a glance.

codecov-io · 2019-07-12T22:21:32Z

Codecov Report

Merging #682 into master will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #682      +/-   ##
==========================================
- Coverage    82.3%   82.26%   -0.05%     
==========================================
  Files          95       95              
  Lines        6625     6625              
==========================================
- Hits         5453     5450       -3     
- Misses       1172     1175       +3

Impacted Files	Coverage Δ
src/triage/tracking.py	`83.83% <0%> (-3.04%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 18368c1...60207bb. Read the comment docs.

thcrock · 2019-08-20T21:49:34Z

@shaycrk what do you think about merging this? I'm inclined to leave merge decisions up to you and @rayidghani but this seems like it's ready to go now and would add value.

thcrock added 2 commits May 3, 2019 17:00

Repo README overhaul

bee95fc

remove README.rst, replace with README.md

6bc24a8

thcrock requested a review from rayidghani May 3, 2019 22:02

thcrock added 2 commits May 7, 2019 10:45

Add subheaders and improve copy in run section

f2449c3

Fix postmodeling link

074e62c

rayidghani marked this pull request as ready for review June 6, 2019 18:26

shaycrk reviewed Jun 11, 2019

View reviewed changes

thcrock added 3 commits June 13, 2019 17:07

Changes from review

a41a50c

More changes

625ac1b

Disambiguate development headers

511ad6c

shaycrk reviewed Jun 13, 2019

View reviewed changes

thcrock added 3 commits June 14, 2019 09:48

Phase header changes

f69d99c

Merge remote-tracking branch 'origin/master' into repo_readme

1501732

Update setup.py

60207bb

Merge branch 'master' into repo_readme

fa6c530

shaycrk merged commit f8ddde4 into master Dec 11, 2019

shaycrk mentioned this pull request Dec 12, 2019

Kit and adolfos amazing adventure (aka experiment config defaults) Closes #717 #719

Merged

shaycrk deleted the repo_readme branch December 13, 2019 22:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repo readme #682

Repo readme #682

thcrock commented May 3, 2019

thcrock commented May 3, 2019

shaycrk Jun 11, 2019

shaycrk Jun 11, 2019

thcrock Jun 13, 2019

shaycrk Jun 11, 2019

shaycrk Jun 11, 2019

shaycrk Jun 11, 2019

shaycrk Jun 11, 2019

shaycrk Jun 13, 2019

shaycrk Jun 13, 2019

shaycrk Jun 13, 2019

shaycrk commented Jun 13, 2019

codecov-io commented Jul 12, 2019 •

edited

Loading

thcrock commented Aug 20, 2019


		`Experiment` (create features and models) -> `Audition` (pick the best models) -> `Postmodeling` (dive into best models)

		## Documentation Quick Links


		If you're new to Triage Experiments, check out the [Dirty Duck tutorial](https://dssg.github.io/dirtyduck). It's a guided tour through Triage functionality using a real-world problem.

		If you're familiar with creating an Experiment but want to see more reference documentation and some deep dives, check out the links on the side.


		If you're familiar with creating an Experiment but want to see more reference documentation and some deep dives, the [Triage Documentation Site](https://dssg.github.io/triage) has more content.

		## Audition


		To get started with Audition, check out its [README](https://github.com/dssg/triage/tree/master/src/triage/component/audition)

		## Postmodeling

Repo readme #682

Repo readme #682

Conversation

thcrock commented May 3, 2019

thcrock commented May 3, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaycrk commented Jun 13, 2019

codecov-io commented Jul 12, 2019 • edited Loading

Codecov Report

thcrock commented Aug 20, 2019

codecov-io commented Jul 12, 2019 •

edited

Loading