Skip to content

Commit

Permalink
Upgrade Python version and include sesemi as a requirement in the rea…
Browse files Browse the repository at this point in the history
…dthedocs build (#57)

* Install SESEMI in doc requirements

* Update doc requirements

* Add readthedocs settings file
  • Loading branch information
tigist-d authored Apr 29, 2022
1 parent 40fb4de commit bffa2b2
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
_build
/src
/logs
/data
/runs
Expand Down
11 changes: 11 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.8"
sphinx:
configuration: docs/source/conf.py
python:
install:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p><p align="center"><img height="350px" src="https://github.com/FlyreelAI/sesemi/raw/master/assets/sesemi-banner.png" /></p></p>

# Image Classification with Self-Supervised Regularization
<span><img src="https://img.shields.io/badge/license-Apache-blue" /> <img src="https://img.shields.io/badge/python->=3.7-green" /> <img src="https://img.shields.io/badge/pytorch->=1.11.0-light" /> <img src="https://img.shields.io/badge/coverage-79%25-green" /> <img src="https://img.shields.io/badge/%20-contributions%20welcome-5429E6" /></span>
<span><img src="https://img.shields.io/badge/license-Apache-blue" /> <img src="https://img.shields.io/badge/python->=3.8-green" /> <img src="https://img.shields.io/badge/pytorch->=1.11.0-light" /> <img src="https://img.shields.io/badge/coverage-79%25-green" /> <img src="https://img.shields.io/badge/%20-contributions%20welcome-5429E6" /></span>

## Why SESEMI?

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ Sphinx==4.2.0
sphinxcontrib-programoutput
m2r2==0.3.1
mistune==0.8.4
-r ../requirements.txt
-e .
-e git+https://github.com/open-mmlab/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme

0 comments on commit bffa2b2

Please sign in to comment.