First public release

[SamHames]

• Choose a license #43
• Add how to cite. #48
• Migrate repository to a public location #45
• Setup automated releases to PyPI #38 Packaging and PyPI release
• Create a more complete documentation setup #18 Documentation:
• Example notebook/s - working with speeches from Australian Hansard  #46
• Read the docs configuration - or host the docs on github pages instead? #47
• Final Feature work:
  • Support Twittersphere based twitter corpora #39
  • Allow creating a new model and selecting fields through the web interface/CLI #40
  • Revisit visuals and unity between model and individual cluster views  #41
• Logging framework #30 Logging framework
• Can Model Runs Be Deterministic? #33 as a first attempt to tackle some aspects of reproducibility

Out of Scope for first release

• Hierarchical clustering of features - leave to future work/optimisation for large corpora
• Changes to scoring or display of document features
• Design work on corpus - index interface - wait for initial features and use to bed in before abstracting any further
• Visual improvements outside of basic consistency work
• Field related metadata to make suggestions for what to include in the model
• Field related metadata to drive computational associations and drill down

[katkasian]

@SamHames Was wondering if you also want to add a citation reference to the Readme (i.e., How to cite).

[SamHames]

Yes, very good point!