Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 6.2 KB

README.md

File metadata and controls

67 lines (44 loc) · 6.2 KB

Hi class, welcome to the AOS C111/204 final project!

For this project, you will be applying your skills to train a machine learning model using real-world data, then publishing a report on your own website.

  • To get data for your project, you could:

    • use your own data from a separate research activity
    • scour the internet to find something original, then preprocess it yourself - see the Module Overview on BruinLearn for some resources
    • browse an archive of data designed for machine learning problems, such as the UC Irvine Machine Learning Repository

  • Your report should be written in a scientific language and style. This template page gives an example structure that you could use, but feel free to make it your own. See Bruinlearn for some examples from previous students.

Your website will be a great addition to your CV, and a place to host future projects too since it doubles as a GitHub repository. The first step is to set up a project website like this one by following the instructions below.

How does this website work?

First, check out the Github repository for this site: https://github.com/atmosalex/atmosalex.github.io/.

Using GitHub pages, you can write a website using markdown syntax - the same syntax we use to write comments in Google Colab notebooks. GitHub pages then takes the markdown file and renders it as a web page using a Jekyll theme. The markdown source code for this page is shown here.

Setting up your Project Website

How to copy this site as a template

  1. Create a GitHub account
  2. Go to https://github.com/atmosalex/atmosalex.github.io/ and click Use this template, then Create a new repository. screenshot
  3. In the box that says Repository name, write your Github username, followed by .github.io, as shown in the screenshot below. Then click Create repository at the bottom. screenshot
  4. Go to the Settings tab, then click Pages (under Code and automation). In the Build and deployment section, under Branch, select "main" and click save (if it isn't already selected). It should look like this: screenshot
  5. Click the Actions tab at the top of the page and check that the build and deployment action has finished. Once it has, navigate to [your username].github.io to see your site, which should be a copy of this one! If you cannot see an Actions tab, just wait a few minutes then go to your URL to check it is live.

Now you are ready to customize your site! To add your name to the site, go to your repository page on Github, click _config.yml, and edit it to replace the temporary title with your name, etc. When we make changes to a project on Github, we have to commit the new version of each file. Github keeps track of all the changes we make, making it easy to roll back (i.e. return the project to a previous commit).

How to change the theme (optional)

  1. You can choose any theme listed on this page, though some do not work as well on mobile devices.
  2. From GitHub, edit _config.yml and replace the theme: line with theme: jekyll-theme-name where name is the name of the theme from the above list. For the minima theme, use a shortened preface like so theme: minima, the others seem to need the whole preface theme: jekyll-theme-. You can check the Actions tab (as in step 5. above) to make sure the site is building successfully.

How to change your site logo (optional)

  1. Some themes, such as jekyll-theme-minimal, show a logo. In your repository, upload a logo or profile picture to the assets/IMG/ directory
  2. Open _config.yml and modify the line logo: /assets/IMG/template_logo.png to point to your new image

Guide to Adding Content

  • Your repository's README.md file (the file you are reading now) acts like a home page. Replace its contents with whatever you want the world to see by editing the file on GitHub.
  • If you want to turn this page into a CV or blog, etc., it may be useful to refer to a guide for writing Markdown.
  • You can create other markdown files (.md) in your repository and navigate to them from this page using links, i.e.: here is a link to another file, project.md
  • When editing a markdown file on GitHub, it is useful to wrap text by selecting the Soft wrap option as shown: screenshot
  • If you want to get even more technical, you can also write HTML in your .md files, and GitHub Pages will render it. For example, the image below is displayed by writing the following (edit this file to see!): <img align="right" width="200" height="200" src="/assets/IMG/template_frog.png">

Delivering your Project

Your final project is delivered in two components: a report and your code.

Report

Your report should be delivered via your website. Submit a link to your website on BruinLearn so that your instructor can browse it to find your report.

To make this simple, you can write the report using a word processor or Latex, then export it as a .pdf file and upload it to the assets directory. You can then link to it like so. However, you can also type the report directly onto the website using another markdown page - here is a template for that.

Code

A link to your code must be submitted on BruinLearn, and the course instructor must be able to download your code to mark it. The code could be in a Google Colab notebook (make sure to share the notebook so access is set to Anyone with the link), or you could upload the code into a separate GitHub repository, or you could upload the code into the assets directory of your website and link to it.