Skip to content

Commit

Permalink
Merge pull request #113 from UBC-MDS/docs/fix-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jdaduica authored Dec 8, 2024
2 parents 4a3ddb8 + 1632a25 commit a1c2b67
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
editor_options:
markdown:
wrap: sentence
---

# Online Shoppers Purchasing Intention Prediction

Authors: Julian Daduica @jdaduica, Stephanie Ta @Stephanie-Ta, and Wai Ming Wong @waiming
Expand All @@ -28,14 +22,11 @@ The final report can be found [here](https://ubc-mds.github.io/Online-Shoppers-P
We are using a Docker virtual container so that our computational environment is reproducible.
Please ensure that Docker Desktop is running while replicating our analysis if you are using Windows or Mac.

To replicate our analysis: 1.
Clone this GitHub repository to your local machine and navigate to the project root.
2.
Launch the virtual container by running the command `docker compose up` in terminal.
3.
To open JupyterLab, copy and paste the URL in your browser that appears in terminal that starts with `http://127.0.0.1:8888/lab?token=`.
4.
Run the following commands in terminal:
To replicate our analysis:
1. Clone this GitHub repository to your local machine and navigate to the project root.
2. Launch the virtual container by running the command `docker compose up` in terminal.
3. To open JupyterLab, copy and paste the URL in your browser that appears in terminal that starts with `http://127.0.0.1:8888/lab?token=`.
4. Run the following commands in terminal:

```
python scripts/01_extract_data.py --write_to=data/raw/
Expand Down Expand Up @@ -80,10 +71,9 @@ python scripts/08_get_feat_weights.py \
quarto render reports/online_shoppers_purchasing_intention_prediction.qmd
```

To exit and clean up the container: 1.
`Ctrl` + `C` in terminal where you launched the container.
2.
Run the command `docker compose rm` in terminal.
To exit and clean up the container:
1. `Ctrl` + `C` in terminal where you launched the container.
2. Run the command `docker compose rm` in terminal.

# Dependencies

Expand Down

0 comments on commit a1c2b67

Please sign in to comment.