pinot icon indicating copy to clipboard operation
pinot copied to clipboard

prettify before moving forward

Open yuanqing-wang opened this issue 4 years ago • 1 comments

the TODO list to make our repo prettier, cleaner, and more user-friendly before moving forward

  • [ ] a short manifest @yuanqing-wang @jchodera
  • [ ] examples (scripts and/or notebooks?)
    • [ ] supervised learning @yuanqing-wang
    • [ ] semi-supervised learning @dnguyen1196
    • [ ] active learning @miretchin
  • [ ] more assertions and exceptions @yuanqing-wang
  • [ ] logging? @yuanqing-wang
  • [ ] more unittests, @dnguyen1196 @yuanqing-wang
  • [ ] conda installable
  • [x] nicer docs and autodoc page

yuanqing-wang avatar Jun 26 '20 18:06 yuanqing-wang

I'll be happy to contribute to the manifest as well.

I also made a PR on some cleanup activities.

The examples and documentation are major-B BIG issues, I wonder if we would like to have documentationa dn examples as in pyro.ai or , even better, beautiful docs like here https://assaytools.readthedocs.io/en/latest/theory.html .

My sense is I would like to have that.

Let me quickly check sth... and edit this afterwards.

karalets avatar Jun 30 '20 04:06 karalets