Submission.md

Submission

Here you will find details on how to submit your project for the HackSC hackathon.

Required Submission Components

When handing in your project, you will need to include:

• nosana_workshop.ipynb notebook file that you downloaded.
• Updated README.md in the submission/ folder about how the work you have done.

Post-Submission Verification

Clearly outline what each team must include in their submission:

• Ensure your pull request reflects your team name and project.
• Video Presentation: A short (1-2 min) video explaining the project, the problem solved, and a demo of the solution.
• Jupyter Notebook (for AI/ML projects): Ensure it runs independently, contains annotations, and shows results.
• Documentation:
  • Describe any extra instructions for running the Jupyter Notebook
  • Describe the problem that you are trying to solve
  • Describe the technical implementation
  • How did you utilize what you learned during this hackathon in a creative way?
  • Challenges faced
  • Major highlight or milestone doing this hackathon
  • Future improvements

Hackathon Submission Plan

1. Forking the Repository

All students will be begin by forking the repository. Go to github.com/nosana-ci/workshop to Fork the repository to your GitHub account.

2. Save and Download the Jupyter Notebook

Remember to Save your nosana_workshop.ipynb file before downloading it.

When you are ready to hand in your work, please download your Jupyter Notebook, the nosana_workshop.ipynb file.

3. Submitting, by Pull Request

When handing in your project, you will need to include:

• nosana_workshop.ipynb notebook file that you downloaded.
• Updated README.md in the submission/ folder about how the work you have done.

You can upload the nosana_workshop.ipynb file via the GitHub interface.

4. Create a Pull Request:

Submit a pull request to the main repository:

• Title: [Team Name] Full Repository Submission
• Description:
  • Team name and members.

This can be done via the GitHub interface, go to the main Nosana workshop repo. There should be a Compare & pull request button.

Afterwards we need to double check that we are indeed trying to merge with the correct repo (Nosana workshop repo). We also need to make sure we are trying to merge the correct branches! Don't forget to add a tittle and a description, and hit Create pull request.

5. Congratulations!

You've submitted your assignment, go and touch grass!