Update readme.md

readme.md

@@ -12,20 +12,20 @@ load_dataset('thbndi/Mimic4Dataset', task, mimic_path=mimic_data, config_path=co
 
 ## Arguments
 
-1. `task` (string, default="Mortality"):
+1. `task` (string) :
    - Description: Specifies the task you want to perform with the dataset.
    - Default: "Mortality"
    - Note: Possible Values : 'Phenotype', 'Length of Stay', 'Readmission', 'Mortality'
 
-2. `mimic_path` (string):
+2. `mimic_path` (string) :
    - Description: Complete path to the Mimic-IV raw data on user's machine.
    - Note: You need to provide the appropriate path where the Mimic-IV data is stored.
 
-3. `config_path` (string) optionnal:
+3. `config_path` (string) optionnal :
    - Description: Path to the configuration file for the cohort generation choices (more infos in '/config/readme.md').
    - Default: Configuration file provided in the 'config' folder.
 
-4. `encoding` (string, default="concat"):
+4. `encoding` (string) optionnal :
    - Description: Data encoding option for the features.
    - Options: "concat", "aggreg", "tensor", "raw", "text"
    - Default: "concat"
@@ -36,17 +36,17 @@ load_dataset('thbndi/Mimic4Dataset', task, mimic_path=mimic_data, config_path=co
      - "raw": Provide cohort from the pipeline without any encoding for custom data processing.
      - "text": Represents diagnoses as text suitable for BERT or other similar text-based models.
 
-5. `generate_cohort` (bool, default=True):
+5. `generate_cohort` (bool) optionnal :
    - Description: Determines whether to generate a new cohort from Mimic-IV data.
    - Default: True
    - Note: Set it to True to generate a cohort, or False to skip cohort generation.
 
-6. `val_size`, 'test_size' (float):
+6. `val_size`, 'test_size' (float) optionnal :
    - Description: Proportion of the dataset used for validation during training.
    - Default: 0.1 for validation size and 0.2 for testing size.
    - Note: Can be set to 0.
 
-7. `cache_dir` (string):
+7. `cache_dir` (string) optionnal :
    - Description: Directory where the processed dataset will be cached.
    - Note: Providing a cache directory for each encoding type can avoid errors when changing the encoding type.