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

Documenting Hakaru workflow #92

Open
GenevaS opened this issue Jun 26, 2017 · 9 comments
Open

Documenting Hakaru workflow #92

GenevaS opened this issue Jun 26, 2017 · 9 comments
Assignees

Comments

@GenevaS
Copy link
Contributor

GenevaS commented Jun 26, 2017

We want to document (as tutorials) some of the problems that people want to solve and how they would do it using Hakaru.

@GenevaS GenevaS self-assigned this Jun 26, 2017
@zaxtax
Copy link
Member

zaxtax commented Jun 26, 2017 via email

@GenevaS
Copy link
Contributor Author

GenevaS commented Jun 26, 2017

I have already created a page for the general workflow for Hakaru programming (7a849c3) and the burglary alarm example from the system description paper (6e257c8).

Which examples should I work on next?

@ccshan
Copy link
Member

ccshan commented Jun 26, 2017

Thanks!

Regarding the burglary example, I would recommend (1) documenting the optional use of simplification (rather than sampling) after disintegration to figure an exact (rather than approximate) answer to the problem; (2) add each transformation in the documented workflow as tests.

Regarding which example next, I would recommend the second of the two examples of the system description paper, which we call "easier roadmap".

@GenevaS
Copy link
Contributor Author

GenevaS commented Jun 30, 2017

I've added simplification to the discrete model workflow (fc2af24) and I will start work on the continuous model.

@GenevaS
Copy link
Contributor Author

GenevaS commented Aug 28, 2017

As of 45456a1, the continuous model/easy road workflow has been documented and added to the test suite.

@GenevaS
Copy link
Contributor Author

GenevaS commented Aug 30, 2017

I have been reading the paper that was suggested to me for documenting GMM Gibbs, and I have a few questions:

  1. How did you want this example to look in the documentation? It is not like the burglary or thermometer examples (which were published like tutorials). This one looks more like a "Sure, you can do this in Hakaru". My only thought right now is that perhaps this could be added to the "Examples" page with a description of the program and a reference to the paper. If you would prefer a page on its own, what should be included? Regarding testing, this pipeline has already been added to haskell/Tests/RoundTrip.hs.

  2. The first example in the paper is a series of transformations on a Kalman filter. Isn't this the same as the thermometer example (hakaru/tests/RoundTrip/thermometer_workflow.hk)? If it isn't, I want to add it to haskell/Tests/RoundTrip.hs as a pipeline.

@GenevaS GenevaS mentioned this issue Sep 5, 2017
@ccshan
Copy link
Member

ccshan commented Nov 27, 2017

Is this done?

@ccshan ccshan closed this as completed Nov 27, 2017
@JacquesCarette
Copy link
Contributor

I am not actually 100% sure that this is done -- Geneva was waiting for Yuriy to finish a couple of things to close this off, and he didn't finish them until some time in September.

@GenevaS
Copy link
Contributor Author

GenevaS commented Nov 29, 2017

No, this issue has not yet been resolved. I am reopening it, but I will not be able to work on it for a few weeks yet.

@GenevaS GenevaS reopened this Nov 29, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants