📋 Table of contents
Use type hinting in all methods when contributing. Here is an example:
import numpy as np
import torch
def dummy_fun(a: int, b: ndarray, c: torch.tensor) -> list[int]:
pass
- Ensure that git is installed on your machine. Download Git
To run the project, run the following command from the root directory of the project:
docker compose up --build
To run the test suite, run the following command from the root directory of the project:
docker compose run backend python -m pytest
If you want to do quick testing without needing to build the docker image, you can run the following command from the root directory of the project:
pytest backend/tests
If the tests look good locally, then you can build the docker image and run the tests in the docker container using the docker compose run backend pytest
commmand.
This project would not have been possible without the hard work and dedication of all of the contributors. Thank you for the time and effort you have put into making this project a reality.
Distributed under the MIT License. See LICENSE
for more information.
You need to have access to IDUN or another supercomputer. This works for Mac/Linux.
ssh-add ~/.ssh/your_github_key
ssh -A idun.hpc.ntnu.no
Test if github workd:
ssh -T git@github.com