mirror of
https://github.com/Steffo99/unimore-bda-6.git
synced 2024-11-24 16:54:20 +00:00
Complete first chapter
This commit is contained in:
parent
0a0e82d48a
commit
e71baeb41c
GPG key ID:
2A24051445686895
1 changed files with 326 additions and 6 deletions
332
README.md
332
README.md
|
|
@ -32,7 +32,7 @@ In questo progetto si è realizzato una struttura che permettesse di mettere a c
|
|||
|
||||
## Premessa
|
||||
|
||||
### Packaging
|
||||
### Codice e packaging
|
||||
|
||||
Il codice dell'attività è incluso come package Python 3.10 compatibile con PEP518.
|
||||
|
||||
|
|
@ -40,6 +40,10 @@ Il codice dell'attività è incluso come package Python 3.10 compatibile con PEP
|
|||
>
|
||||
> Il progetto non supporta Python 3.11 per via del mancato supporto di Tensorflow a quest'ultimo.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> In questo documento sono riportate parti del codice: in esse, è stato rimosso il codice superfluo come comandi di logging, docstring e commenti, in modo da mantenere l'attenzione sull'argomento della rispettiva sezione.
|
||||
|
||||
#### Installazione del package
|
||||
|
||||
Per installare il package, è necessario eseguire i seguenti comandi dall'interno della directory del progetto:
|
||||
|
|
@ -113,21 +117,328 @@ Per creare indici MongoDB potenzialmente utili al funzionamento efficiente del c
|
|||
$ mongosh < ./data/scripts/index-db.js
|
||||
```
|
||||
|
||||
## Introduzione
|
||||
|
||||
|
||||
|
||||
## Costruzione di una struttura per il confronto
|
||||
|
||||
Al fine di effettuare i confronti richiesti dalla consegna dell'attività, si è deciso di realizzare un modulo Python che permettesse di confrontare vari modelli di Sentiment Analysis tra loro, con tokenizer, training set e test set diversi tra loro.
|
||||
Al fine di effettuare i confronti richiesti dalla consegna dell'attività, si è deciso di realizzare un package Python che permettesse di confrontare vari modelli di Sentiment Analysis tra loro, con tokenizer, training set e test set diversi tra loro.
|
||||
|
||||
Il package, chiamato `unimore_bda_6`, è composto da vari moduli, ciascuno descritto nelle seguenti sezioni.
|
||||
|
||||
### Configurazione ambiente e iperparametri - `.config`
|
||||
|
||||
Il primo modulo, `unimore_bda_6.config`, definisce le variabili configurabili del package usando [`cfig`], e, se eseguito, mostra all'utente un'interfaccia command-line che le descrive e ne mostra i valori attuali.
|
||||
|
||||
Viene prima creato un oggetto [`cfig.Configuration`], che opera come contenitore per le variabili configurabili:
|
||||
|
||||
```python
|
||||
import cfig
|
||||
config = cfig.Configuration()
|
||||
```
|
||||
|
||||
In seguito, per ogni variabile configurabile viene definita una funzione, che elabora il valore ottenuto dalle variabili di ambiente del contesto in cui il programma è eseguito, convertendolo in un formato più facilmente utilizzabile dal programma.
|
||||
|
||||
Si fornisce un esempio di una di queste funzioni, che definisce la variabile per configurare la dimensione del training set:
|
||||
|
||||
```python
|
||||
@config.optional()
|
||||
def TRAINING_SET_SIZE(val: str | None) -> int:
|
||||
"""
|
||||
The number of reviews from each category to fetch for the training dataset.
|
||||
Defaults to `4000`.
|
||||
"""
|
||||
if val is None:
|
||||
return 4000
|
||||
try:
|
||||
return int(val)
|
||||
except ValueError:
|
||||
raise cfig.InvalidValueError("Not an int.")
|
||||
```
|
||||
|
||||
> In gergo del machine learning / deep learning, queste variabili sono dette iperparametri, perchè configurano la creazione del modello, e non vengono configurati dall'addestramento del modello stesso!
|
||||
|
||||
Infine, si aggiunge una chiamata al metodo `cli()` della configurazione, eseguita solo se il modulo viene eseguito come main, che mostra all'utente l'interfaccia precedentemente menzionata:
|
||||
|
||||
```python
|
||||
if __name__ == "__main__":
|
||||
config.cli()
|
||||
```
|
||||
|
||||
L'esecuzione del modulo `unimore_bda_6.config`, senza variabili d'ambiente definite, dà quindi il seguente output:
|
||||
|
||||
```console
|
||||
$ python -m unimore_bda_6.config
|
||||
===== Configuration =====
|
||||
|
||||
MONGO_HOST = '127.0.0.1'
|
||||
The hostname of the MongoDB database to connect to.
|
||||
Defaults to `"127.0.0.1"`.
|
||||
|
||||
MONGO_PORT = 27017
|
||||
The port of the MongoDB database to connect to.
|
||||
Defaults to `27017`.
|
||||
|
||||
WORKING_SET_SIZE = 1000000
|
||||
The number of reviews to consider from the database.
|
||||
Set this to a low number to prevent slowness due to the dataset's huge size.
|
||||
|
||||
TRAINING_SET_SIZE = 4000
|
||||
The number of reviews from each category to fetch for the training dataset.
|
||||
Defaults to `4000`.
|
||||
|
||||
VALIDATION_SET_SIZE = 400
|
||||
The number of reviews from each category to fetch for the training dataset.
|
||||
Defaults to `400`.
|
||||
|
||||
EVALUATION_SET_SIZE = 1000
|
||||
The number of reviews from each category to fetch for the evaluation dataset.
|
||||
Defaults to `1000`.
|
||||
|
||||
TENSORFLOW_MAX_FEATURES = 300000
|
||||
The maximum number of features to use in Tensorflow models.
|
||||
Defaults to `300000`.
|
||||
|
||||
TENSORFLOW_EMBEDDING_SIZE = 12
|
||||
The size of the embeddings tensor to use in Tensorflow models.
|
||||
Defaults to `12`.
|
||||
|
||||
TENSORFLOW_EPOCHS = 3
|
||||
The number of epochs to train Tensorflow models for.
|
||||
Defaults to `3`.
|
||||
|
||||
===== End =====
|
||||
```
|
||||
|
||||
### Recupero dati dal database - `.database`
|
||||
|
||||
Il modulo `unimore_bda_6.database` si occupa della connessione al database [MongoDB] e la collezione contenente il dataset di partenza, del recupero dei documenti in modo bilanciato, della conversione di essi in un formato più facilmente leggibile da Python, e della creazione di cache su disco per permettere alle librerie che lo supportano di non caricare l'intero dataset in memoria durante l'addestramento di un modello.
|
||||
|
||||
#### Connessione al database - `.database.connection`
|
||||
|
||||
Il modulo `unimore_bda_6.database.connection` si occupa della conessione (e disconnessione) al database utilizzando il package [`pymongo`].
|
||||
|
||||
Definisce un context manager che effettua automaticamente la disconnessione dal database una volta usciti dal suo scope:
|
||||
|
||||
```python
|
||||
@contextlib.contextmanager
|
||||
def mongo_client_from_config() -> t.ContextManager[pymongo.MongoClient]:
|
||||
client: pymongo.MongoClient = pymongo.MongoClient(
|
||||
host=MONGO_HOST.__wrapped__,
|
||||
port=MONGO_PORT.__wrapped__,
|
||||
)
|
||||
yield client
|
||||
client.close()
|
||||
```
|
||||
|
||||
Esso sarà poi utilizzato in questo modo:
|
||||
|
||||
```python
|
||||
with mongo_client_from_config as client:
|
||||
...
|
||||
```
|
||||
|
||||
#### Recupero della collezione - `.database.collections`
|
||||
|
||||
Il modulo `unimore_bda_6.database.collection` si occupa di recuperare la collezione `reviews` dal database MongoDB:
|
||||
|
||||
```python
|
||||
def reviews_collection(db: pymongo.MongoClient) -> pymongo.collection.Collection[MongoReview]:
|
||||
collection: pymongo.collection.Collection[MongoReview] = db.reviews.reviews
|
||||
return collection
|
||||
```
|
||||
|
||||
#### Contenitori di dati - `.database.datatypes`
|
||||
|
||||
Il modulo `unimore_bda_6.database.datatypes` contiene contenitori ottimizzati (attraverso l'attributo magico [`__slots__`]) per i dati recuperati dal database, che possono essere riassunti con:
|
||||
|
||||
```python
|
||||
@dataclasses.dataclass
|
||||
class TextReview:
|
||||
text: str
|
||||
rating: float
|
||||
|
||||
@dataclasses.dataclass
|
||||
class TokenizedReview:
|
||||
tokens: list[str]
|
||||
rating: float
|
||||
```
|
||||
|
||||
#### Query su MongoDB - `.database.queries`
|
||||
|
||||
Il modulo `unimore_bda_6.database.queries` contiene alcune query pre-costruite utili per operare sulla collezione `reviews`.
|
||||
|
||||
##### Working set
|
||||
|
||||
Essendo il dataset completo composto da 23 milioni, 831 mila e 908 documenti (23_831_908), effettuare campionamenti su di esso in fase di sviluppo risulterebbe eccessivamente lento e dispendioso, pertanto in ogni query il dataset viene rimpicciolito a un *working set* attraverso l'uso del seguente aggregation pipeline stage, dove `WORKING_SET_SIZE` è sostituito dal suo corrispondente valore nella configurazione (di default 1_000_000):
|
||||
|
||||
```javascript
|
||||
{"$limit": WORKING_SET_SIZE},
|
||||
```
|
||||
|
||||
##### Dataset con solo recensioni 1* e 5* - `sample_reviews_polar`
|
||||
|
||||
Per recuperare un dataset bilanciato di recensioni 1* e 5*, viene utilizzata la seguente funzione:
|
||||
|
||||
```python
|
||||
def sample_reviews_polar(collection: pymongo.collection.Collection, amount: int) -> t.Iterator[TextReview]:
|
||||
category_amount = amount // 2
|
||||
|
||||
cursor = collection.aggregate([
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 1.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
{"$unionWith": {
|
||||
"coll": collection.name,
|
||||
"pipeline": [
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 5.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
],
|
||||
}},
|
||||
{"$addFields": {
|
||||
"sortKey": {"$rand": {}},
|
||||
}},
|
||||
{"$sort": {
|
||||
"sortKey": 1,
|
||||
}}
|
||||
])
|
||||
|
||||
cursor = map(TextReview.from_mongoreview, cursor)
|
||||
|
||||
return cursor
|
||||
```
|
||||
|
||||
L'aggregazione eseguita non è altro che l'unione dei risultati delle seguenti due aggregazioni, i cui risultati vengono poi mescolati attraverso l'ordinamento su un campo contenente il risultato dell'operatore [`$rand`]:
|
||||
|
||||
```javascript
|
||||
db.reviews.aggregate([
|
||||
{"$limit": WORKING_SET_SIZE},
|
||||
{"$match": {"overall": 1.0}},
|
||||
{"$sample": {"size": amount / 2}},
|
||||
])
|
||||
// unita a
|
||||
db.reviews.aggregate([
|
||||
{"$limit": WORKING_SET_SIZE},
|
||||
{"$match": {"overall": 5.0}},
|
||||
{"$sample": {"size": amount / 2}},
|
||||
])
|
||||
// e poi mescolate
|
||||
```
|
||||
|
||||
##### Dataset bilanciato con recensioni 1*, 2*, 3*, 4* e 5*
|
||||
|
||||
Lo stesso procedimento viene usato per ottenere un dataset bilanciato di recensioni con ogni numero possibile di stelle:
|
||||
|
||||
```python
|
||||
def sample_reviews_varied(collection: pymongo.collection.Collection, amount: int) -> t.Iterator[TextReview]:
|
||||
category_amount = amount // 5
|
||||
|
||||
cursor = collection.aggregate([
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 1.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
{"$unionWith": {
|
||||
"coll": collection.name,
|
||||
"pipeline": [
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 2.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
{"$unionWith": {
|
||||
"coll": collection.name,
|
||||
"pipeline": [
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 3.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
{"$unionWith": {
|
||||
"coll": collection.name,
|
||||
"pipeline": [
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 4.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
{"$unionWith": {
|
||||
"coll": collection.name,
|
||||
"pipeline": [
|
||||
{"$limit": WORKING_SET_SIZE.__wrapped__},
|
||||
{"$match": {"overall": 5.0}},
|
||||
{"$sample": {"size": category_amount}},
|
||||
],
|
||||
}}
|
||||
],
|
||||
}}
|
||||
],
|
||||
}}
|
||||
],
|
||||
}},
|
||||
{"$addFields": {
|
||||
"sortKey": {"$rand": {}},
|
||||
}},
|
||||
{"$sort": {
|
||||
"sortKey": 1,
|
||||
}}
|
||||
])
|
||||
|
||||
cursor = map(TextReview.from_mongoreview, cursor)
|
||||
|
||||
return cursor
|
||||
```
|
||||
|
||||
### Tokenizzatore astratto - `.tokenizer.base`
|
||||
|
||||
Si è realizzata una classe astratta che rappresentasse un tokenizer qualcunque, in modo da avere la stessa interfaccia a livello di codice indipendentemente dal package di tokenizzazione utilizzato:
|
||||
|
||||
```python
|
||||
class BaseTokenizer(metaclass=abc.ABCMeta):
|
||||
|
||||
@abc.abstractmethod
|
||||
def tokenize(self, text: str) -> t.Iterator[str]:
|
||||
"Convert a text `str` into another `str` containing a series of whitespace-separated tokens."
|
||||
raise NotImplementedError()
|
||||
|
||||
def tokenize_review(self, review: TextReview) -> TokenizedReview:
|
||||
"Apply `.tokenize` to the text of a `TextReview`, converting it in a `TokenizedReview`."
|
||||
tokens = self.tokenize(review.text)
|
||||
return TokenizedReview(rating=review.rating, tokens=tokens)
|
||||
```
|
||||
|
||||
### Analizzatore astratto - `.analysis.base`
|
||||
|
||||
Allo stesso modo, si è realizzato una classe astratta per tutti i modelli di Sentiment Analysis:
|
||||
|
||||
```python
|
||||
class BaseSentimentAnalyzer(metaclass=abc.ABCMeta):
|
||||
@abc.abstractmethod
|
||||
def train(self, training_dataset_func: CachedDatasetFunc, validation_dataset_func: CachedDatasetFunc) -> None:
|
||||
"Train the analyzer with the given training and validation datasets."
|
||||
raise NotImplementedError()
|
||||
|
||||
@abc.abstractmethod
|
||||
def use(self, text: str) -> float:
|
||||
"Run the model on the given input, and return the predicted rating."
|
||||
raise NotImplementedError()
|
||||
|
||||
def evaluate(self, evaluation_dataset_func: CachedDatasetFunc) -> EvaluationResults:
|
||||
"Perform a model evaluation by calling repeatedly `.use` on every text of the test dataset and by comparing its resulting category with the expected category."
|
||||
... # Descritta successivamente
|
||||
```
|
||||
|
||||
### Logging - `.log`
|
||||
|
||||
Si è configurato il modulo [`logging`] di Python affinchè esso scrivesse sia su console sia sul file `./data/logs/last_run.tsv` le operazioni eseguite dal programma.
|
||||
|
||||
Il livello di logging viene regolato attraverso la costante magica [`__debug__`] di Python, il cui valore cambia in base alla presenza dell'opzione di ottimizzazione [`-O`] dell'interprete Python.
|
||||
|
||||
### Tester - `.__main__`
|
||||
|
||||
Infine, si è preparato un tester che effettuasse una valutazione di efficacia per ogni combinazione di funzione di campionamento, tokenizzatore, e modello di Sentiment Analysis:
|
||||
|
||||
```python
|
||||
|
||||
if __name__ == "__main__":
|
||||
...
|
||||
for sample_func in [...]:
|
||||
for SentimentAnalyzer in [...]:
|
||||
for Tokenizer in [...]:
|
||||
...
|
||||
```
|
||||
|
||||
## Ri-implementazione dell'esercizio con NLTK - `.analysis.nltk_sentiment`
|
||||
### Wrapping del tokenizzatore di NLTK - `.tokenizer.nltk_word_tokenize`
|
||||
### Ri-creazione del tokenizer di Christopher Potts - `.tokenizer.potts`
|
||||
|
|
@ -147,3 +458,12 @@ Al fine di effettuare i confronti richiesti dalla consegna dell'attività, si è
|
|||
## Confronto dei modelli
|
||||
|
||||
## Conclusione
|
||||
|
||||
|
||||
|
||||
[`cfig`]: https://cfig.readthedocs.io
|
||||
[MongoDB]: https://www.mongodb.com
|
||||
[`$sample`]: https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/
|
||||
[`$rand`]: https://www.mongodb.com/docs/v6.0/reference/operator/aggregation/rand/
|
||||
[`__debug__`]: https://docs.python.org/3/library/constants.html#debug__
|
||||
[`-O`]: https://docs.python.org/3/using/cmdline.html#cmdoption-O
|
||||
|
|
|
|||
Loading…
Reference in a new issue