owlbarn/tutorial

Owl Tutorial

tutorial's Issues

Migrate existing content to new book building system.

Tooling: add paper/book references

Fix the LaTeX render problem in markdown

In the markdown file, LaTeX expression such as $\sqrt{2}$ will fail with message [WARNING] Could not convert TeX math '\sqrt{2}', rendering as TeX. Using $\sqrt\{2\}$ does not fix the problem.

This issue might be caused by pandoc.

sketch testing framework chapter

Add exercises at the end of each chapter

Organise regression, interpolation, etc. in existing book chapters.

Including count-sketch, regression, interpolation, root-finding, Orthogonal polynomials, kmeans, svm, etc.

sketch community dev chapter

Be practical; learning from existing book on open source.

Tooling issue: removed image restored after `make`

When writing the book, sometimes I add images to the source code but later found that some images should be deleted. However, after running make, those deleted images come back to the source code.

This is because the old images are all copied to the container and then all copied back to host. The solution is simple, just make clean and then make should suffice. This is a just minor issue.

Finish metrics system chapter

sketch internal utility chapter

Add MathJax support so we can use LaTex in writing.

Fix INSTALL link on the menu

add author bio to pdf book, cosmetic changes.

Tweak the dune build sequence, make the building more smooth.

Cleanup preludes and dependencies

We are inheriting lots of these from rwo, but we have different needs.

Currently in the various prelude.ml we start with

#require "core,core.top,ppx_jane,owl-top,owl-plplot";;

open Core
open Owl
open Bigarray

I believe we should only use

#require "owl-top";;

open Owl

Sometimes we will need plplot as well but in general I think we can also omit that at first.

implment bag of worlds, lsa, and etc in NLP module.

Fix the image path for compiled HTML.

sketch finance case chapter

• May need to remove the Schloss part
• try using existing OCaml interface to Linear programming to solve portfolio management problem
  • or use MC

update introduction chapter

• what is scientific computing
• what is functional programming

Define second level of TOC

revise image formats

Update the images once the first draft is out. Including:

• low quality images
• non-white background screenshot
• ...

enable PDF format of the book.

This will take some efforts. I was close last time, but got some issues in embedding the images.

also require latex will bloat the docker image a lot.

weekly progress meeting

• adjust writing strategy, add example structure first.
• keep dumping content, can keep language dry atm.
• set up daily and weekly goal, no best-effort execuse.

Set up tooling, plotting, format, travis CI, and etc.

polish the index.html and find cover image.

Add reference support in the book.

Sketch object detection case chapter

update stats chapter, add more example

Try KaTex, replace MathJax if better.

sketch style transfer case chapter

Clean up the book folder.

Several files are copied directly from RWO, not really useful to Owl for the time being. The book folder needs to be cleaned up.

Update CGraph chapter with Pierre's work

Containerise the building process.

Especially useful if plotting is used because the generated figures may vary on different platforms, need to be consistent.

Fix the font on compiled html site.

The default font used in the compiled html site looks really bad, need to change to better font.

Fix the left nav bar.

The fixed position is not right on ToC, it doesn't align well when scrolling the pages.

Create repo for tutorial book.

Refine the content in NLP chapter

sketch out NLP chapter

Update NLP interface for similarity and lda

Integrate with Travis CI

Automate the building process of the book.

sketch Symbolic chapter

Add Part III for Case studies

Migrate visualisation tutorial to new book.

Before we have a new solution, current plplot is the default tool for plotting.

sketch AEOS chapter

sketch regression chapter

contact potential publishers

Implement FFT-2D

And fftshit and a representative filter.

Transfer responsiblities: book planning, chapter design, and etc.,

sketch out stats chapter

sketch signal processing chapter