Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pseusys/imagine_food
https://github.com/pseusys/imagine_food
Last synced: about 12 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/pseusys/imagine_food
- Owner: pseusys
- Created: 2024-11-05T05:11:49.000Z (14 days ago)
- Default Branch: main
- Last Pushed: 2024-11-08T09:27:46.000Z (11 days ago)
- Last Synced: 2024-11-08T10:29:34.749Z (11 days ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Imagine Food
> COMP4471 final project
## Requirements
### Running notebooks
- [`python3`](https://www.python.org/) version 3.8+
- [`poetry`](https://python-poetry.org/) version 1.5+
### Building report
- [`latexmk`](https://mg.readthedocs.io/latexmk.html) version 4.76+
- [`chktex`](https://www.nongnu.org/chktex/) version 1.7+
## Install
This project is built with poetry and can be installed with this command:
```shell
python3 -m pip install poetry
```
In order to install dependencies and create a virtual environment, just run:
```shell
poetry install
```
### Run in VSCode
In order to run notebooks with a virtual environment created by `poetry`, do the following:
1. Run `poetry env info`, fubd the `Executable: [PATH]` line in the output.
2. Create `.vscode/settings.json` file and add the following content there:
```json
{
"python.defaultInterpreterPath": "[PATH]"
}
```
3. Open the notebook, click kernel icon -> `Select another kernel...` -> `Python environments...`, your virtual environment will be marked with a star, select it.
## Report
This template is modified from the template by [Ming-Ming Cheng](mailto:[email protected]) from Nankai University, see also [website](https://github.com/MCG-NKU/CVPR_Template).
That version was again modified from the the old CVPR/ICCV template files contributed by [Paolo Ienne](mailto:[email protected]) and [someone else](mailto:[email protected]).
The report is automatically built and released each and every time a tag is pushed to the GitHub repo.
It can also be built locally with the following command:
```shell
latexmk -pdf -file-line-error -halt-on-error -interaction=nonstopmode -output-directory=report report/report.tex
```
LaTeX code style can be checked with this command:
```shell
chktex report/bibliography.bib report/report.tex
```