Added Readme

This commit is contained in:
Mysaa 2023-11-28 23:42:35 +01:00
parent c01ffefaac
commit 1b2d118f2e
Signed by: Mysaa
GPG Key ID: 7054D5D6A90F084F

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Projet 2-27-1 Computational Structures and Logics for Natural Language Modelling
This project is packed in a jupyter notebook, along with answers to the questions. To run the notebook, you have to install jupyter notebooks and run `jupyter-notebook Report.ipynb`.
### Files
The different files of the repository are the following:
- `Report.ipynb` : The code and answers to the questions, and remarks about the code
- `ccg.ods` : A Spreadsheet describing the grammar we created, with its semantics
- `phrases.txt` : A set of grammatical sentences that should be successfully parsed by our grammar.
- `randomizedTests.txt` : A set of sentences generated randomly, mostly to check the strictness of the grammar
### Run the project
You will need to install the following packages in order to run the code from the notebook:
- nltk
- pandas
- jupyter