Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lupin1998 committed Mar 21, 2024
1 parent 1f0ffb3 commit 6c66ad5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 26 deletions.
16 changes: 8 additions & 8 deletions docs/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
copyright = '2021-2024, CAIRI'
author = 'CAIRI OpenMixup Authors'

# The full version, including alpha/beta/rc tags
version_file = '../../openmixup/version.py'
# # The full version, including alpha/beta/rc tags
# version_file = '../../openmixup/version.py'


def get_version():
with open(version_file, 'r') as f:
exec(compile(f.read(), version_file, 'exec'))
return locals()['__version__']
# def get_version():
# with open(version_file, 'r') as f:
# exec(compile(f.read(), version_file, 'exec'))
# return locals()['__version__']


# release = get_version()
Expand Down Expand Up @@ -186,8 +186,8 @@ def get_version():
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(root_doc, 'openmixup', 'OpenMixup Documentation', author, 'openstl',
'CAIRI Supervised, Semi- and Self-Supervised Visual Representation Learning Toolbox and Benchmark.', 'Miscellaneous'),
(root_doc, 'openmixup', 'OpenMixup Documentation', author,
'CAIRI Supervised, Semi- and Self-Supervised Visual Representation Learning Toolbox and Benchmark.', 'Miscellaneous'),
]

# -- Options for Epub output -------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/en/tutorials/1_new_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ILSVRC2012_val_00000004.JPEG 809
ILSVRC2012_val_00000005.JPEG 516
```

Note: The value of ground-truth labels should fall in range `[0, num_classes - 1]`. Please refer to [INSTALL](https://github.com/Westlake-AI/openmixup/tree/main/docs/en/install.md) [meta files](https://github.com/Westlake-AI/openmixup/releases/download/dataset/meta.zip) for examples.
Note: The value of ground-truth labels should fall in range `[0, num_classes - 1]`. Please refer to [INSTALL](https://github.com/Westlake-AI/openmixup/tree/main/docs/en/install.md) for setup instructions and [meta files](https://github.com/Westlake-AI/openmixup/releases/download/dataset/meta.zip) for the list file examples.

### An example of customized dataset

Expand Down
17 changes: 0 additions & 17 deletions requirements/readthedocs.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,2 @@
attrs
einops
importlib-metadata
matplotlib
mmcv-full>=1.4.7,<=1.7.2
numpy
opencv-python
packaging
pandas
scipy
scikit-learn
seaborn
six
tensorboard
timm
tqdm
torch
torchvision
openmixup

0 comments on commit 6c66ad5

Please sign in to comment.