Agenda:
- Reminder: Quiz 8 out today!
- PA7 Overview (5 minutes)
- Recommendation Systems Question (NOT THIS TIME - Lab 4 next week!)
- Getting started with Github (45 minutes)
- Group Norms (10 minutes)
For PA7 we will be building a custom movie recommendation chatbot! We will implement our chatbot with 3 different designs: slot-filling dialogue agent (GUS), LLM prompting chatbot, and a hybrid LLM augmented bot.
PA7 is worth 18% of your total grade, and conveniently split into exactly 100 points!
Here's the point breakdown:
- PA7 Coding (85 Points)
- PA7 User Testing (5 Points)
- PA7 Reflection (10 points)
You can find instructions, rubrics, FAQs, and links to all resources for PA7 coding in the PA7 GitHub README page.
All submissions will be made through gradescope. Note that no late days can be used for PA7!!!
You will have time to discuss with your teammates at the end of today's Lab!
Before you start:
- Watch lecture videos up to Chatbots & Recommender Systems.
- Make sure your team has received together.ai credit.
- Check out the PA7 Screencast for detailed info!
- We will cover GitHub usage later today. Also check out GitHub Tutorial video by Michael Ryan for step-by-step guidance.
| M3 | 1 | | M4 | -1 | | M5 | 1 | | M6 | 0 |
Working on a coding project with a large team can be messy! Everytime you or your teammates make any changes, you need to sync the files with everyone. What if two of you make changes at the same time? That's why we need version control tools like Git. Git allows you to:
- Manage the changes made by collaborators easily.
- View the full history of code changes and revert to earlier version.
Git has a lot of jargon and can be confusing. We have prepared an (optional) handbook for your reference in case you get lost.
We will use Git with GitHub!
If you don't have a Github account yet, make one here! Everyone in your group will need a GitHub account. We have found that chrome and edge work better for this than safari due to GitHub's unique captcha test. After account creation any browser should work fine!
Also be sure to install Github desktop which will be our tool of choice for connecting to GitHub and sending/recieving updates to our codebase.
Only one person in your group needs to do steps 1 and 2. Navigate to the new repository creation page on GitHub.
You can call the repository whatever you'd like but be sure to mark it as a Private repository since we'll be storing your project code here.
Leave the rest of the settings to their defaults and click Create repository.
Click the Invite collaborators button to invite your group partners to the repository.
Under Manage access click Add people. Search for your partners and add them to the repository. You can add them with Admin access. They will need to check their email for an invitation.
All Group Members should follow this step!
Open up Github Desktop which you can download here.
Sign in to GitHub Desktop. There may be a button to do so when you first open it, but if not you can still sign in through the menu. If you are on mac, click GitHub Desktop and then Settings.
Then click Sign Into GitHub.com.
If you are on Windows, click File then Options
Then click Sign In under GitHub.com, not GitHub Enterprise.
Sign in with your browser and enable the permissions requested for GitHub Desktop.
All Group Members should follow this step!
If this is your first time using Github Desktop you may see a Clone a repository from the internet button
Otherwise you'll find the Clone button under Current Repository, Add, Clone Repository
There you'll find the option to clone Your Repositories from GitHub.com. You'll also find repositories that you've been added as a collaborator to.
Choose to Clone your group's repository to somewhere convenient on your PC. Choose a path that you'll remember and know where to find!
ONLY ONE GROUP MEMBER SHOULD COMPLETE THIS STEP
There are several ways we can get the PA7 files into your local repo, but the easiest way without making any assumptions about your setup is to download a zip file from GitHub and extract it into this new local repo we've created!
Navigate to the course PA7 Repository (not the one you just created).
Click Code and Download ZIP.
This should've downloaded a file pa7-chatbot-main. If it is still zipped, be sure to extract the file into a folder.
This is where it is important that you remember the path where you saved your local repository! Drag the pa7-chatbot-main folder into the folder where you are storing your repository.
When you return to GitHub desktop you should see all the files are being tracked!
In total there are 27 Tracked Files. Let's upload them to our shared repository!
Add a summary in the lowerleft hand corner to describe the update. This should be a brief message, called a commit message. When we make a commit we save a snapshot of the current version of our codebase! You can call this commit something like Added starter code.
Then click Commit to main.
This has saved a snapshot of your code locally, but we need to upload it so everyone in your group can access it! Click Publish branch which will push your changes to GitHub.
Everyone besides the person who completed step 5 needs to complete this step.
Where the publish button was for the person making the changes, everyone will find a "Fetch origin" button. Click it!
This will check the GitHub repository for any updates. It should find the changes that one group member just pushed. Everyone should click the button again to "Pull" the changes.
PAUSE! Now is an important time to take a moment and check that everything is working! Does everyone have a copy of the repository locally with all the same files? Does your GitHub repository have all of the project files in a private repository? Does everyone in your group have access to the repository? If the answer to any of these questions is no, ask a CA for help!!
Everyone in your group should do this step, and do it with slightly different changes
Let's go through the typical workflow of making edits to your project and sharing the changes to your group.
First fetch and pull any changes to the code that have been made. This is what you did in Step 6.
Navigate to the chatbot.py file and open it up in your preferred editor. This is going to be the file where you do the bulk of the work for PA7.
You'll find a method in this file greeting:
def greeting(self):
"""Return a message that the chatbot uses to greet the user."""
########################################################################
# TODO: Write a short greeting message #
########################################################################
greeting_message = "How can I help you?"
########################################################################
# END OF YOUR CODE #
########################################################################
return greeting_messageThis is the message that your chatbot will display to initiate the conversation.
Have everyone in your group write a slightly different greeting message!
Now return to GitHub Desktop:
You should see the change tracked! Just as before we'll add a commit message and then push to main! (Refer to the last part Step 5 if you're confused).
But wait? For all but one of you you should be seeing this message:
We all changed the same code at the same time... now we have to resolve a merge conflict.
Click Fetch then Pull origin.
Often times when working on a shared repository you'll face issues where two people change the same line of code. This results in a merge conflict, since git doesn't know which version to keep and which to discard.
Let's work through resolving this merge conflict.
Some of your group members should see this message:
There may be an option to open in Visual Studio Code, however this is not necessary. You can resolve a merge conflict in any code editor (even notepad!). Open up chatbot.py in an editor of your choice.
You'll see both versions of the changes:
def greeting(self):
"""Return a message that the chatbot uses to greet the user."""
########################################################################
# TODO: Write a short greeting message #
########################################################################
<<<<<< HEAD
greeting_message = "Hey what's up?"
=======
greeting_message = "Howdy! What can I do you for?"
>>>>>> b4eeed1d1ec226b004bf5b55738d112f6cfe8eb0
########################################################################
# END OF YOUR CODE #
########################################################################Choose which one gets to stay and which one has to go! Delete the special characters, and leave the file so that it can execute properly.
Return to GitHub desktop and you should see a message confirming that the merge conflict has been resolved:
Click Continue Merge and finish pushing your changes to the remote repository.
If you happen to have finished with your GitHub setup early then now would be a great time to follow this 5 minute guide to get your Together API keys set up for the project!
Communication is the key to success in team work. Communicate your expectations and plans for this project with your teammates! Meanwhile, if you have any questions, the CAs are here to help you. Enjoy!
Below are some tips on effective and efficient group discussion:
