Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waikato-ufdl/ufdl-backend
User-Friendly Deep Learning (UFDL) - backend system.
https://github.com/waikato-ufdl/ufdl-backend
backend deeplearning python3 ufdl
Last synced: about 1 month ago
JSON representation
User-Friendly Deep Learning (UFDL) - backend system.
- Host: GitHub
- URL: https://github.com/waikato-ufdl/ufdl-backend
- Owner: waikato-ufdl
- License: apache-2.0
- Created: 2019-10-03T03:41:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-28T20:40:00.000Z (5 months ago)
- Last Synced: 2024-07-28T21:45:46.824Z (5 months ago)
- Topics: backend, deeplearning, python3, ufdl
- Language: Python
- Homepage:
- Size: 1000 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ufdl-backend
User-Friendly Deep Learning (UFDL) - backend system.
## Requirements
* Python 3.8 (including development headers)
```commandline
sudo apt-get install python3.8 python3.8-dev libpython3.8-dev
```
* essential build environment
```commandline
sudo apt-get install build-essential
```
* additional libraries
```commandline
sudo apt-get install libsm6 libxrender1 virtualenv
```
* when using a MySQL backend ensure that `mysql_config` is present
```commandline
sudo apt-get install libmysqlclient-dev
```
## Scripts
* `dev_init.sh` - for setting up the virtual environment `venv.dev` that runs a
developer instance. You may want to adjust the parameters in the automatically
generated file `./venv.dev/lib/python3.7/site-packages/ufdl/api_site/secret.py`
(like `DEBUG` and `ALLOWED_HOSTS`). Use `-h` for outputting the help screen.
* `dev_reset.sh` - simply resets the database state (the virtual environment must exist)
* `dev_start.sh` - launches the developer instance from the `venv.dev` virtual
environment on [http://localhost:8000](http://localhost:8000), unless the IP
address and port to bind to is provided as argument (e.g., `0.0.0.0:8000`)
## Environment variables
The following environment variables can be used to
* `UFDL_DATABASE_TYPE` - the database to use for the backend (`sqlite3|postgresql`, default: `sqlite3`)
* `UFDL_POSTGRESQL_HOST` - host for PostgreSQL DB
* `UFDL_POSTGRESQL_USER` - user for PostgreSQL DB
* `UFDL_POSTGRESQL_PASSWORD` - password for PostgreSQL DB
## Docker
See [here](docker/) for more scripts or [documentation](https://ufdl.cms.waikato.ac.nz/getting-started/#docker-compose-docker).
## API documentation
For API documentation see:
* [repository](https://github.com/waikato-ufdl/ufdl-api)
* [website](https://waikato-ufdl.github.io/ufdl-api/)