IFT 3710/6759 - Projets (avancés) en apprentissage automatique

Git tutorial

A dummy repository for educational purposes

A playground for you to play

Add your name and GitHub username to the list (or anything else if you do not want to add your personal information):

• Alex Hernandez-Garcia, alexhernandezgarcia
• The fantastic Ada Lovelace, adalovelace
• Marie Curie, mariecurie

Intro to Markdown

This page is written with Markdown. Markdwon is a markup language, which means that it is a system for writing text alongside other information which is readable by a computer. Other markup languages are HTML and XML. However, Markdown is lightweight which means that the annotations are fairly simple and the overall result is easily readable.

For example, you can easily write text in bold by enclosing the piece of text with a pair of asterisks (**). Italics is made signed with enclosing underscores (_). And of course you can combine bold and italics---guess how? It's also possible to do ~~this kind of stuff~~. By the way, since a couple of years ago, Slack, Whatsapp and Telegram, and other messaging apps, also support this kind of markup annotations, as you may know.

Creating hyperlinks is also really easy. Here's one link to a pretty random website. To create a hyperlink, you enclose the text of the link with square brackets, [like this], immediately followed by the actual URL enclosed with parentheses, that is (https://alexhernandezgarcia.github.io/teaching/mlprojects/).

Markdown also allows to easily write fixed width text, using backticks: `code`. This is useful for writing formatting pieces of code. But it's also possible to write code blocks by enclosing the code with 3 backticks (```). For example, this illustrates the basic workflow with git:

git clone https://github.com/alexhernandezgarcia/ift-3710-6759-h24.git cd ift-3710-6759-h24/ git checkout -b playground-branch touch new-file echo "banana" > new-file git status git add new-file git commit -m "new file with banana" git push

Other beauties of Markdown

This is, of course, not all Markdown can do! There are many more formatting options, and what is great of it is that everything is quite intuitive and easy to learn and remember. There are multiple resources online to learn about Markdown. One example is the Markdown Guide, which has a Getting started guide, an overview of the syntax and a cheatsheet. Let's look at some of the more common features of Markdown in this page!

Lists

Unordered lists

Unordered lists can be built using asterisks (*), dashes (-) or plus signs (+). And indentation is supported to create different levels:

• Brain
  • Visual cortex
  • V1
  • V2
  • V4
  • Auditory cortex
  • A1
  • A2
  • A3
• Artificial neural networks
  • Convolutional layers
  • Recurrent layers

Ordered lists

Guess how you can create ordered lists?

1. Un
   1. Eins
   2. Zwei
   3. Drei
2. Deux
3. Trois
   1. Uno
   2. Dos
   3. Tres

Horizontal rules

Horizontal rules can be created with a sequence of three dashes (---), or three asteriks or underscores.

New stuff below the rule.

Sections or Headers

Maybe you have noticed that this page is organised in headings at different levels. The title of the first level is preceded by one number sign (# Heading 1), the second by two (## Heading 2), and so on and so forth.

And more

Check this syntax guide for how to do other things, and try some of it right here!