Welcome to HKJournalist’s documentation!

• Slides for sharing: Download Link

It is a light and useful Python module, helping you generate a small size, pretty report as PDF slides (or any other format documents which human can directly read and hand out) each time after your programs finish. All you need to do is to customize a report template using MarkDown with variables name which used in your Python program, and maintain a dict to store those variables. Then, A few lines of code added before end of programs can automatically fetch and display them in final report file. Also, code deal with frequent structure/arguments changes or data source changes can benefit from the package if the report can play a role of ‘snapshot’ (with timestamp) of each code version.

Home:

• Quick Start
  • Pre-requirements
  • Install
  • Customize your report template
  • Run a Journalist() in your code to fetch variables
  • Invite a journalist to make a big news report
  • Final question: What will my variables on slides look like?
• Auto Generate Template
  • I am too lazy to write a md template
  • Example
• Tutorial 1: Run a prophet model on time series
  • Prepare a dict to store variables
  • Load data
  • Plot data
  • Split train and test set
  • Build a model
  • Fit this model and plot the prediction
  • Define a custom metric to evaluate model
  • Detail data for error analysis
  • Add some personal note to describe your model
  • Finally, here comes the Journalist!
  • Output slides
• Tutorial 2: EDA and select feature
  • Load Data and pass basic statistics data to config
  • Plot the correlation matrix
  • Filter features with high correlation coefficient
  • HKJournalist can use auto-generated template before making a big report!
  • Output
• Tutorial 3: Write templates with Chinese characters
  • Pre-requirements
  • Specify the header in md template
  • Write main part of your program
  • Turn on zh
  • Final report
• API
  • Submodules
  • hkjournalist.journalist module
  • Module contents

Indices and tables

• Index
• Module Index
• Search Page