Skip to content

Commit e42b616

Browse files
authored
fix: typos in setup (#14)
* fix: updated cell2sentence reference and tasks for category 1 * feat: added setup guide * fix: instructions for running the streamlit app the first time * fix: typos
1 parent f29173d commit e42b616

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/setup.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ hide:
1515
- Version control: [GitHub](https://github.com/VirtualPatientEngine)
1616
- AI Agent application requirements: [Streamlit](https://streamlit.io/), [Ollama](https://ollama.com/), [LangChain](https://www.langchain.com/), and [FAISS](https://github.com/facebookresearch/faiss)
1717

18+
## Setup
1819
### Step 1: Introduction to our computational research platform with Code Ocean
1920
1. View a [short overview video](https://www.youtube.com/watch?v=k_qddEpTEjo) of the Code Ocean platform
2021
2. Review further information in the Code Ocean [user guide](https://docs.codeocean.com/user-guide) if needed
@@ -26,8 +27,8 @@ hide:
2627
4. After team members update their capsules branch, members should `push` to their teams branch
2728
5. Each team member then updates their capsules with their team members contributions by `pulling` to their capsules branch
2829

29-
> <font color=black>💡tips</font><br>
30-
> 1. Use the command line `terminal` in the VS Code editor for pushing and pulling using `git`<br>
30+
> <font color=black>💡Tip</font><br>
31+
> 1. Use the command line `terminal` in the VS Code editor for running `git` commands <br>
3132
> 2. Quick reference of [git commands](https://www.geeksforgeeks.org/git-cheat-sheet/) if you forget and the [full documentation](https://git-scm.com/docs/git) if typing `git --help` is not sufficient
3233
3334
### Step 3: Familiarization with the template Code Ocean AI Agents capsule
@@ -45,9 +46,9 @@ hide:
4546
4647
3. Extended examples needed for completing the Hackathon challenges
4748

48-
> <font color=black>💡tips</font><br>
49+
> <font color=black>💡Tip</font><br>
4950
> 1. Use the `Scratch` folder for downloading large data files<br>
50-
> 2. Use the VS Code editor to launch the Ollama server, interact with Streamlit, and code
51+
> 2. Use the VS Code editor to launch the Ollama server, interact with Streamlit, coding, etc.
5152
5253
### Step 4: Launching, working in, and stopping the capsule
5354
1. Click the `VS Code` icon on the top right under `Reproducible run` to launch a cloud workstation on AWS; Please note that the first time you launch a capsule it will take a few minutes to allocate the resources on AWS.
@@ -62,6 +63,7 @@ hide:
6263
4. Update your branch with your teams changes
6364

6465
> git fetch --all --prune<br>
66+
> git checkout feat/name<br>
6567
> git merge team/name<br>
6668
6769
5. Share your changes with your teams branch

0 commit comments

Comments
 (0)