https://bloomberg.github.io/foml/

Foundations of Machine Learning
https://bloomberg.github.io/foml/

Last synced: 9 days ago
JSON representation

Foundations of Machine Learning

• Host: GitHub
• URL: https://bloomberg.github.io/foml/
• Owner: bloomberg
• Created: 2018-06-29T23:00:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T20:09:43.000Z (7 months ago)
• Last Synced: 2024-10-22T07:42:28.808Z (13 days ago)
• Language: Handlebars
• Homepage: https://www.techatbloomberg.com/foml
• Size: 3.07 MB
• Stars: 336
• Watchers: 16
• Forks: 53
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• data-science-awesome-reference - FOUNDATIONS OF MACHINE LEARNING by Bloomberg

README

        
#  Foundations of Machine Learning

## Editing, rebuilding, and deploying this page

### Building locally: quickstart

Be sure to have [Node.js](https://iojs.org/) 7.x+ installed.

Run `npm install` in the project root. This will install some build tools we use.

Run `npm run build-in-place` to do the templating and stylesheet compilation in-place. You can then view the site by simply opening `index.html`.

Run `./build.sh` to do a local build into the `out/` directory. You can then preview the site at `out/index.html`. This should usually be the same as just `index.html`, but it is good to check before committing, since this "local deploy" process is slightly more complicated than the in-place build process.

### How to edit content

The file index.hbs is usually what you should edit, basically as though you were editing an HTML file. The final HTML is generated with some JavaScript processing that pulls in data from the YAML files in the data directory -- basically the information in the lectures and assignments tables. 

### Deployment

Run the script `./deploy.sh` from the root directory of the project to build and deploy the page to GitHub.  The script does the following: 1) Pulls down the gh-pages branch into a folder called "out" in the project root directory. (GitHub serves webpages from gh-pages branches.) Then it runs `npm run build` which compiles the page and puts the output into out. Then the revised out folder is committed and pushed back to the gh-pages branch, ready to be served.

### Technologies used

[Stylus](https://learnboost.github.io/stylus/) is used for styling.

[Handlebars](http://handlebarsjs.com/) is used for templating. `index.hbs` is minimally templated, mostly delegating to the partials in `templates/`. Those pull their data from `data/`. The logic that ties them all together is in `build/templater.js`.

The site is intended to be responsive, which we accomplish with per-device stylesheets and media queries in the HTML.

### Things to Keep in Mind

While editing you should be using an [EditorConfig](http://editorconfig.org/) plugin for your text editor to enforce a few basic stylistic things.

We are trying to maintain a reasonable HTML document outline (so, don't use `` as if it were `
`). To preview the document outline, use the [HTML 5 Outliner tool](https://gsnedders.html5.org/outliner/).