Spaces:
Runtime error
Runtime error
EveSa commited on
Update README.md
Browse filesRemove duplicate lines
README.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
| 1 |
-
<<<<<<< HEAD
|
| 2 |
---
|
| 3 |
title: SummaryProject
|
| 4 |
sdk: docker
|
|
@@ -73,87 +72,6 @@ Estelle SALMON
|
|
| 73 |
|
| 74 |
Lingyun GAO
|
| 75 |
|
| 76 |
-
|
| 77 |
## License
|
| 78 |
|
| 79 |
-
|
| 80 |
-
=======
|
| 81 |
-
---
|
| 82 |
-
title: SummaryProject
|
| 83 |
-
sdk: docker
|
| 84 |
-
app_file: src/api.py
|
| 85 |
-
pinned: false
|
| 86 |
-
---
|
| 87 |
-
|
| 88 |
-
# Project Deep Learning - Text Summarisation tool and it's application programming interface
|
| 89 |
-
|
| 90 |
-
As part of the master course "Neural Network",for this university project, our task is about creating a application, a interface or a python library in the use of NLP(Natural Language Processing) with the help of an artificial neural network system.
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
## Description
|
| 94 |
-
|
| 95 |
-
**Objectives of our project :**
|
| 96 |
-
|
| 97 |
-
Create a interface which allows users to sammrize a long text like press article into a brief version.
|
| 98 |
-
|
| 99 |
-
To achieve this general objective, for the algorithm part, we would like to test two different deep learning methods: setting up a LSTM model and fine tuning Transformer model.
|
| 100 |
-
|
| 101 |
-
For the interface, having a interface building with fastAPI framework and putting the application on Huggingface.
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
## Getting Started
|
| 105 |
-
|
| 106 |
-
### Préparation
|
| 107 |
-
|
| 108 |
-
* Open the link below directing towards our interface on huggingface.
|
| 109 |
-
```
|
| 110 |
-
https://huggingface.co/spaces/EveSa/SummaryProject
|
| 111 |
-
```
|
| 112 |
-
### The interface
|
| 113 |
-
|
| 114 |
-
* 1- Choosing a model for your summarization task (LSTM/Fine-tuned T5) by clicking on the scroll-down list. And click the Select model botton.
|
| 115 |
-
|
| 116 |
-
* 2- Enter your text to summarize in the left section.
|
| 117 |
-
|
| 118 |
-
* 3- Click on 'Go!' botton and you will get your sammary!
|
| 119 |
-
|
| 120 |
-
* 4- Dont forget to reset the App for your next try. The botton is at the right next to 'Go!'.
|
| 121 |
-
|
| 122 |
-
## In case you want to try to execute our scripts :
|
| 123 |
-
|
| 124 |
-
### Préparation
|
| 125 |
-
* In order to run the script, you need:
|
| 126 |
-
|
| 127 |
-
* 1- Create a virtual environment named .venv
|
| 128 |
-
```
|
| 129 |
-
python3 -m virtualenv .venv
|
| 130 |
-
source .venv/bin/activate
|
| 131 |
-
```
|
| 132 |
-
* 2- Also install the dependencies
|
| 133 |
-
```
|
| 134 |
-
pip install -U -r requirements.txt
|
| 135 |
-
```
|
| 136 |
-
|
| 137 |
-
* You are now ready to execute the scripts ^^
|
| 138 |
-
|
| 139 |
-
### The programme api.py
|
| 140 |
-
|
| 141 |
-
* Run the script with the command below:
|
| 142 |
-
```
|
| 143 |
-
python3 api.py
|
| 144 |
-
```
|
| 145 |
-
* This code generate the same page as on Huggingface in your browser. To do the task your may follow the steps in the previous section.
|
| 146 |
-
|
| 147 |
-
## Authors
|
| 148 |
-
|
| 149 |
-
Eve Sauvage
|
| 150 |
-
|
| 151 |
-
Estelle SALMON
|
| 152 |
-
|
| 153 |
-
Lingyun GAO
|
| 154 |
-
|
| 155 |
-
|
| 156 |
-
## License
|
| 157 |
-
|
| 158 |
-
This project is licensed under the [M2 TAL] License
|
| 159 |
-
>>>>>>> 7f1c2ca2f0a0475d3903b3261a03b02bfaad7374
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: SummaryProject
|
| 3 |
sdk: docker
|
|
|
|
| 72 |
|
| 73 |
Lingyun GAO
|
| 74 |
|
|
|
|
| 75 |
## License
|
| 76 |
|
| 77 |
+
This project is licensed under the [M2 TAL] License
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|