diff --git a/README.md b/README.md index 63bd513..ce75ba3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,48 @@ # ๐ŸŒŠ Kaggle Tutorial ๐Ÿšข -Kick-off repository for starting with Kaggle prepared by `ลšwita Znachora` for WAVE 3 Workshops! +> Welcome to the **Kaggle Titanic Tutorial**! This repository is designed as a starter guide for Kaggle competitions, created by **ลšwita Znachora** for WAVE 3 Workshops. ๐Ÿš€ +The Titanic Competition is a great way to start with Kaggle and machine learning. Your goal is to predict which passengers survived the Titanic tragedy based on various attributes such as age, class, and gender. + +Helpful links: - [How to Use Kaggle](https://www.kaggle.com/docs/api#getting-started-installation-&-authentication) - official guide how to use Kaggle via API. - [Titanic Competition](https://www.kaggle.com/competitions/titanic/overview/evaluation) -Download the dataset using the following commands: +### ๐Ÿ“‹ Prerequisites + +**Kaggle Account**: Make sure you have a Kaggle account. Sign up [here](https://www.kaggle.com/account/login) if you donโ€™t already have one. + +**Kaggle API Token**: +- Go to [Account Settings](https://www.kaggle.com/account). +- Scroll to "API" and click "Create New API Token." +- Save the `kaggle.json` file in the folder: `~/.kaggle/`. + +**Install Poetry**: +Poetry is used to manage dependencies. Follow the installation instructions [here](https://python-poetry.org/docs/). + +### โญ Repository Setup + +**Star and Fork the Repository**: +- Click the "Star" button at the top of this repository. ๐ŸŒŸ +- Click the "Fork" button to create your own copy of the repository. + +**Clone Your Fork**: + Once you've forked the repository, clone it to your local machine: + ```shell + git clone https://github.com/knsiczarnamagia/kaggle-tutorial.git +```` +Install dependencies +```shell +make install +``` +### ๐Ÿš€ Using the Repository +Download the Titanic Dataset +Run the following command to download and prepare the dataset: +```shell +make kaggle-download +``` +Submit Your Solution +Once you've prepared your solution (e.g., edited gender_submission.csv), you can submit it to Kaggle: ```shell -kaggle competitions download -c titanic -mkdir -p ./data/titanic -unzip titanic.zip -d ./data/titanic -rm titanic.zip +make kaggle-submit ``` \ No newline at end of file