Scribd
Upload
25 views2 pages

Intro To Ai Submission Guidelines

Uploaded by

phungtienthanh2004
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
25 views2 pages

Intro To Ai Submission Guidelines

Uploaded by

phungtienthanh2004
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

Well done! You have almost made it to the end of this course’s project.

Congratulations on your
hard work. The remaining step is to send in your work for grading. The deadline for this is 11.59
p.m. Dec 29 (Fri). Each group should only have one representative submitting.

For your project to be graded, refer to the following guidelines for submission. Some might find
this guide intuitive and redundant; regardless, please take your time reading through it.

1. Within this assignment submission screen, attach two items.


i. The GitHub link to the repository containing every piece of project-related source code.
ii. The pdf file that is your written report. Name it as follows: 20231_intro_ai_group_xxx.pdf

2. Source code
- In general, there are no set guidelines on the structure of your code. For ease of assessment
though, try to come up with a way to structure and name your files in a clear and meaningful
manner.
- It would be most convenient if you can push (upload) your code into a GitHub repository. I will
run this command to access your work: `git clone # link_to_your_repo`. I will then move
to the root directory to run your code.
- Despite the first remark, there are some files that you should have.
+ requirements.txt: This file should be placed at the root of the repository. Assuming you
code everything in Python, this file should contain the names of the libraries or dependencies I
need to install to run your code. This is a common practice in application development. I will run
`pip install -q -r requirements.txt` to install the libraries. This is a common
convention, and you can search on the Web for more details on writing this file.
+ main.py: This file should be placed at the root of the repository. Assuming that you code
everything in Python, this file, when run, should print out whatever results you want to show, be
it a demonstration of what your AI agent can do or some experimentation results, or both, if
you’d like. Think of me as a naïve user trying your program out, so be as clear as possible in
your demonstration. To run this, I will use `python main.py # necessary_parameters`

+ README.md: This file should be placed at the root of the repository. This serves as an
instruction manual, and you can put in any information you think would make your project code
clearer – though try not to make this file too long. You should include the scripts (i.e., the
instructions in red above, after filling in the part that is currently commented out) in this
markdown file, so that I can copy and paste it instead of having to retype it.
- Rest assured that beyond running your code, I will also look into the actual code for
assessment. An effort to make your code as clear as possible will reflect positively in the
grading process.
- As a last resort, if your group is absolutely unfamiliar with GitHub and finds these guidelines
too confusing, instead of pasting the link to your GitHub repository, you can submit a zipped file
of your code. Only do this if all alternatives are impossible. Please contact me or research
carefully if there is still time left until the deadline and you have questions.

3. Report
- Again, there is no set rule on the structure of your report. Beside a few necessary sections
such as problem description and formulation, solution proposal and analysis, and
experimentation results, the flow and the format of your written report can be flexible, so long as
it follows a logical and coherent structure, with clear explanations on everything you do or
observe.
- However, an acknowledgment of the sources you have used as reference is absolutely
required. Failure to comply with this will flag your report as plagiarized.
- Refer to the guide (posted by your professor) on this course’s Facebook group for more tips
and advice.

You might also like