update readme and example

AsakoKabe · May 2, 2023 · 964f811 · 964f811
1 parent 3a449d6
commit 964f811
Show file tree

Hide file tree

Showing 4 changed files with 524 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 <img src="https://github.com/AsakoKabe/AdeleCV/blob/main/docs/logo.png?raw=true" alt="drawing" width="200"/>
 
+**Auto DEap LEarning Computer Vision**
+
 **Python library and dashboard for hyperparameter search and model training for computer vision tasks
 based on [PyTorch](https://pytorch.org/), [Optuna](https://optuna.org/),
     [FiftyOne](https://docs.voxel51.com/), [Dash](https://dash.plotly.com/),
@@ -24,7 +26,7 @@ The main features of this library are:
  - Displaying training statistics in tensorboard
  - Support for all samples from optuna
  - Segmentation use smp: 9 model architectures, popular losses and metrics, see [doc smp](https://github.com/qubvel/segmentation_models.pytorch)
- - Convert weights to another format, currently supported - 0
+ - Convert weights to another format, currently supported - 1 (onnx)
 
 ### [📚 Project Documentation 📚](https://adelecv.readthedocs.io/en/latest/)
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -83,7 +83,7 @@ def get_version():
 import faculty_sphinx_theme
 
 html_theme = "faculty_sphinx_theme"
-html_logo = "logo.png"
+html_logo = "_static/logo.png"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/export.rst b/docs/export.rst
@@ -1,4 +1,4 @@
-Export
+Export and Convert
 ===================================
 
 .. automodule:: adelecv.api.modification_models