Skip to content
Snippets Groups Projects
Commit 3473e977 authored by Shivam Khandelwal's avatar Shivam Khandelwal
Browse files

Copied information about the phases to README

parent f8273b94
No related branches found
No related tags found
No related merge requests found
......@@ -123,10 +123,16 @@ This will run all the phases (pre_training, purchase & prediction) locally and s
# 👥 Participation
The flow for active participation look as follows:
The participation flow look as follows:
<img src="https://i.imgur.com/xzQkwKV.jpg" width="700">
<img src="https://i.imgur.com/4mgcD5N.jpg">
Quick description about all the phases:
* **Runtime Setup**<br/>You can use `environment.yaml` for all your packages requirement from Conda and PyPI. In case you are advanced developer and need more freedom, checkout all the other supported [runtime configurations here](https://discourse.aicrowd.com/t/how-to-specify-runtime-environment-for-your-submission/2274).
* **Pre-Train Phase**<br/>It is your typical training phase. You need to implement `pre_training_phase` function and it will have access to `training_dataset` (instance of [ZEWDPCBaseDataset](https://gitlab.aicrowd.com/zew/data-purchasing-challenge-2022-starter-kit/-/blob/master/dataset.py)). Learn more about it by referring to [inline documentation here](https://gitlab.aicrowd.com/zew/data-purchasing-challenge-2022-starter-kit/-/blob/ea8c3171/run.py#L32-48).
* **Purchase Phase**<br/>In this phase you have access to unlabelled dataset as well, which you can probe till your budget lasts. Learn more about it by referring to [inline documentation here](https://gitlab.aicrowd.com/zew/data-purchasing-challenge-2022-starter-kit/-/blob/ea8c3171/run.py#L74-85).
* **Prediction Phase**<br/>In this phase, you have access to a test set, and you are supposed to make predictions using your trained models. [inline documentation here](https://gitlab.aicrowd.com/zew/data-purchasing-challenge-2022-starter-kit/-/blob/ea8c3171/run.py#L107-117)
# 🧩 Repository structure
......@@ -136,7 +142,6 @@ The flow for active participation look as follows:
--- | ---
`ZEWDPCBaseRun` (class in [`run.py`](https://gitlab.aicrowd.com/zew/data-purchasing-challenge-2022-starter-kit/-/blob/master/run.py#L9)) | Entry point to your implementation
`aicrowd.json` | A configuration file used to identify the challenge and resources needed for evaluation
`apt.txt` | List of packages that should be installed (via `apt`) for your code to run
`environment.yaml` | List of python packages that should be installed (including `pip` packages) for your code to run
## Other important files
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment