Skip to content

Commit

Permalink
changed readme - using mongo now, no sqlite anymore
Browse files Browse the repository at this point in the history
  • Loading branch information
Iddoyadlin committed Mar 28, 2022
1 parent 954119e commit 1036710
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,16 @@ You can run the game with:
PORT=<PORT> python app.py
```
Configurations can be set in `config.py` (not part of the repo as it contains secrets).
If you want to use local SQLite (`word2vec.db`) set env var: `LITE=1`.
you should be using a mongo server for storing the vectors. Word2Vec model was trained as described (here)[https://github.com/Iddoyadlin/hebrew-w2v]


## Scripts
There are some useful scripts in the `scritps/` folder:
There are some useful scripts in the `scripts/` folder:

- `populate.py`: Given a Word2Vec model, will populate SQL table used by the game.
- `populate.py`: Given a Word2Vec model, will populate mongo collection used by the game.
- `set_secret.py`: Well...
- `semantle.py`: A CLI version of the game.

## Tests
Only for some of the logic right now, because I was lazy. Sorry.

## FAQ
The db (`word2vec.db`) is part of the repository due to ease of deployment to heroku.

If you find a free/cheap SQL server that can hold ~250MB I'll appreiciate it and will
remove it from the repo.

0 comments on commit 1036710

Please sign in to comment.