OpenCampus - Application of Transformers

Installation

Hugging Face + PyTorch

Using Hugging Face on MacOs requires the following dependency to be installed BEFORE the PyTorch installation.

• If the libshm.dylib file is missing, run:
  brew install libomp

Poetry

Poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. About Poetry.

• Install Poetry	OS	Command
  Windows	(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
  Mac	curl -sSL https://install.python-poetry.org | python3 -

• After installing poetry restart terminal/cmd
  

• (Optional) Config Poetry venv inside the repository:
  poetry config virtualenvs.in-project true

• Create the venv with Python >=3.10:
  poetry env use /full/path/to/python

• After creating the venv restart the shell:
  poetry shell

• The installations of all libraries can be done via:
  poetry install

  • (Optional) The dependencies are separated into groups. Groups can be included and excluded:
    poetry install --without Group1,Group2 or poetry install --with Group1,Group2
    More info can be found here.

• Install pre-commit yaml:
  pre-commit install

Development Setup

This Repo enforces some coding standards.

• Git settings:
  pull.rebase=true

• VSCode settings:
  

  "editor.codeActionsOnSave": {
      "source.organizeImports": true
  },
  "editor.formatOnSave": true,
  "files.trimTrailingWhitespace": true,
  "python.formatting.provider": "black",
  "python.formatting.blackArgs": [
      "--line-length",
      "100"
  ],