Commit 6aae26f8 authored by saeedm's avatar saeedm
Browse files

fix README

parent 694d8433
......@@ -28,16 +28,16 @@ More aspects of the training process can be configured:
--time_step 100
```
* __train_file__: JSON file containing training data.
* __model_arch__: T5 Architecture used
* __output_path__: Path to save the model and tokenizer
* __max_length__: Man length for tokenization
* __epochs__: number of epochs
* __batch_size__: training batch size
* __learning_rate__: Learning Rate
* __epsilon__: AdamW epsilon value
* __verbose__: prints training progress
* __time_step__: sets the number of steps before printing
* __--train_file__: JSON file containing training data.
* __--model_arch__: T5 Architecture used
* __--output_path__: Path to save the model and tokenizer
* __--max_length__: Man length for tokenization
* __--epochs__: number of epochs
* __--batch_size__: training batch size
* __--learning_rate__: Learning Rate
* __--epsilon__: AdamW epsilon value
* __--verbose__: prints training progress
* __--time_step__: sets the number of steps before printing
## Testing
For testing, an input file and model path are required. Check ```sample_input.tsv``` for examples. The script produces a new TSV file with the added annotations from the fine-tuned model. The script caches the output for later use.
......@@ -53,10 +53,10 @@ A cache file can be used:
--gen_steps 10 \
--max_length 100
```
* __input_file__: TSV file containing test data.
* __model_path__: Model Path
* __cache_file__: Cache File in JSON format
* __gen_steps__: Number of decoding steps
* __max_length__: maximum length for tokenization
* __--input_file__: TSV file containing test data.
* __--model_path__: Model Path
* __--cache_file__: Cache File in JSON format
* __--gen_steps__: Number of decoding steps
* __--max_length__: maximum length for tokenization
## License
[MIT](https://choosealicense.com/licenses/mit/)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment