pavan
/
citation-analysis
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

WIP : README Documentation - Spelling Errors & Notes

Browse Source
isaac
Pavan Mandava 5 years ago
parent 9e47b20bed
commit 0f2e8343f1
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File

10
README.md
Unescape View File

@ -44,15 +44,16 @@ After activating the Virtual Environment, the console should look like this:
```shell ```shell
git clone https://github.com/yelircaasi/citation-analysis.git git clone https://github.com/yelircaasi/citation-analysis.git
``` ```
Now change the current working directory to the project root folder (`> cd citation-analysis`) Now change the current working directory to the project root folder (`> cd citation-analysis`). <br />
**Note:** Stay in the Project root folder while running all the experiments. **Note:** Stay in the Project root folder while running all the experiments.
#### Installing Pacakages #### Installing Pacakages
Now we can install all the packages required to run this project, available in [requirements.txt](/requiements.txt) file. Now we can install all the packages required to run this project, available in [requirements.txt](/requirements.txt) file.
```shell ```shell
(citation-env) [user@server citation-analysis]$ pip install -r requirements.txt (citation-env) [user@server citation-analysis]$ pip install -r requirements.txt
``` ```
#### Environment Variable for Saved Models Path #### Environment Variable for Saved Models Path
Run the below line in the console, we'll use this variable later on.
```shell ```shell
export SAVED_MODELS_PATH=/mount/arbeitsdaten/studenten1/team-lab-nlp/mandavsi_rileyic/saved_models export SAVED_MODELS_PATH=/mount/arbeitsdaten/studenten1/team-lab-nlp/mandavsi_rileyic/saved_models
``` ```
@ -144,7 +145,7 @@ Our BiLSTM AllenNLP model contains 4 major components:
- Batch Size - Batch Size
- Dropout - Dropout
- Embeddings - Embeddings
- All the classes that config file uses must register using decorators (Ex: `@Model.register('bilstm_classifier'`). - All the classes that the Config file uses must register using Python decorators (Ex: `@Model.register('bilstm_classifier'`).
4. Predictor - [IntentClassificationPredictor](/testing/intent_predictor.py) 4. Predictor - [IntentClassificationPredictor](/testing/intent_predictor.py)
- AllenNLP uses `Predictor`, a wrapper around the trained model, for making predictions. - AllenNLP uses `Predictor`, a wrapper around the trained model, for making predictions.
- The Predictor uses a pre-trained/saved model and dataset reader to predict new Instances - The Predictor uses a pre-trained/saved model and dataset reader to predict new Instances
@ -159,7 +160,8 @@ $ allennlp train \
-s $SAVED_MODELS_PATH/experiment_10 \ -s $SAVED_MODELS_PATH/experiment_10 \
--include-package classifier --include-package classifier
``` ```
We ran a few experiments on this model, the configurations, results and archived models are available in `SAVED_MODELS_PATH` directory We ran a few experiments on this model, the run configurations, results and archived models are available in the `SAVED_MODELS_PATH` directory. <br />
**Note:** If the GPU cores are not available, set the `"cuda_device":` to `-1` in the [config file](/configs/basic_model.json?raw=true), or the available GPU Core.
### Evaluation ### Evaluation
To evaluate the model, simply run: To evaluate the model, simply run:

Write Preview
Loading…
Cancel
Save