/CS269-projects-2022fall

Primary LanguageSCSSMIT LicenseMIT

UCLA CS269 2022 Fall Reinforcement Learning Course Project

Project page: https://ucla-rlcourse.github.io/CS269-projects-2022fall/

Instruction for running this site locally

Note You don't have to run this site locally since we only require you to upload the markdown files and relevent figures.

  1. Follow the first 2 steps in pull-request-instruction

  2. Installing Ruby with version 3.0.0 if you are using a Mac, and ruby 2.7 should work for Linux, check https://www.ruby-lang.org/en/documentation/installation/ for instruction.

  3. Installing Bundler and jekyll with

gem install --user-install bundler jekyll
# Make sure you are in project-2022fall folder.
bundler install
bundle add webrick
  1. Run your site with
bundle exec jekyll serve

You should see an address pop on the terminal (http://127.0.0.1:4000/CS269-projects-2022fall / by default), go to this address with your browser.

Resources:

Working on the project

  1. Create a folder with your team id under ./assets/images/TEAMID, you will use this folder to store all the images in your project.

  2. Copy the template at ./_posts/2022-09-19-team00.md and rename it with format 2022-09-19-TEAMID.md under ./_posts/. The date in file name does not matter since the post date will be overwritten by the date field in front matter of the post. Please fill in the name(s) of team members and add the team ID after. We should stick to pattern 2022-09-19-teamXX.md in file name so it would be easier for you to find the post of your team when editing.

  3. Check out the sample posts we provide and the source code as well as basic Markdown syntax.

  4. Start your work in your .md file. You may only edit the .md file you just copied and renamed, and add images to ./assets/images/TEAMID. Please do NOT change any other files in this repo.

Once you save the .md file, jekyll will synchronize the site and you can check the changes on browser.

Submission

We will use git pull request to manage submissions.

Once you've done, follow steps 3 and 4 in pull-request-instruction to make a pull request BEFORE the deadline. Please make sure not to modify any file except your .md file and your images folder. We will merge the request after all submissions are received, and you should able to check your work in the project page on next week of each deadline.