docs and readme fixing

sisinflab · Mar 6, 2024 · c524163 · c524163
1 parent 9fb7951
commit c524163
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -179,3 +179,42 @@ Currently, Ducho is maintained by:
 - Giuseppe Gassi ([email protected])
 - Claudio Pomo ([email protected])
 - Tommaso Di Noia ([email protected])
+
+### Cite Us
+
+#### DUCHO 2.0
+
+If you use our code in a scientific work, don't forget to cite us :)
+
+```bibtex
+@inproceedings{DBLP:conf/www/AttimonelliDMPGD24,
+  author       = {Matteo Attimonelli and
+                  Danilo Danese and
+                  Daniele Malitesta and
+                  Claudio Pomo and
+                  Giuseppe Gassi and
+                  Tommaso Di Noia},
+  title        = {Ducho 2.0: Towards a More Up-to-Date Feature Extraction and
+Processing Framework for Multimodal Recommendation},
+  booktitle    = {{WWW}},
+  doi          = {10.1145/3589335.3651440}
+  publisher    = {{ACM}},
+  year         = {2024}
+}
+```
+
+#### DUCHO 1.0
+```bibtex
+@inproceedings{DBLP:conf/mm/MalitestaGPN23,
+  author       = {Daniele Malitesta and
+                  Giuseppe Gassi and
+                  Claudio Pomo and
+                  Tommaso Di Noia},
+  title        = {Ducho: {A} Unified Framework for the Extraction of Multimodal Features
+                  in Recommendation},
+  booktitle    = {{ACM} Multimedia},
+  pages        = {9668--9671},
+  doi          = {10.1145/3581783.3613458},
+  publisher    = {{ACM}},
+  year         = {2023}
+}
diff --git a/docs/source/ducho/ducho.multimodal.visual_textual.rst b/docs/source/ducho/ducho.multimodal.visual_textual.rst
@@ -1,9 +1,9 @@
 ducho.multimodal.multiple.visual_textual package
-================================
+=================================================
 
 
 ducho.multimodal.multiple.visual_textual.VisualTextualFeatureExtractor module
-----------------------------------------------------------
+--------------------------------------------------------------------------------
 
 .. automodule:: ducho.multimodal.multiple.visual_textual.VisualTextualFeatureExtractor
 
@@ -12,7 +12,7 @@ ducho.multimodal.multiple.visual_textual.VisualTextualFeatureExtractor module
   :inherited-members:
 
 ducho.multimodal.multiple.visual_textual.VisualTextualDataset module
-----------------------------------------------
+-----------------------------------------------------------------------
 
 .. automodule:: ducho.multimodal.multiple.visual_textual.VisualTextualDataset
 

diff --git a/docs/source/ducho/ducho.runner.rst b/docs/source/ducho/ducho.runner.rst
@@ -1,19 +1,19 @@
 ducho.runner package
-==================
+====================
 
 Submodules
-----------
+-----------
 
 ducho.runner.Runner module
-------------------------
+----------------------------
 
 .. automodule:: ducho.runner.Runner
    :members:
    :undoc-members:
    :show-inheritance:
 
 Module contents
----------------
+----------------
 
 .. automodule:: ducho.runner
    :members:

diff --git a/docs/source/guide/install.rst b/docs/source/guide/install.rst
@@ -6,14 +6,16 @@ Depending on where you are running Ducho, you might need to first clone this rep
 If you are running Ducho on your local machine or Google Colab, you first need to clone this repository:
 
 .. code-block:: bash
-    git clone -b v2 https://github.com/sisinflab/Ducho.git
+
+    $ git clone https://github.com/sisinflab/Ducho.git
 
 
 Then, install the needed dependencies through pip:
 
 .. code-block:: bash
-    pip install -r requirements.txt # Local
-    pip install -r requirements_colab.txt # Google Colab
+
+    $ pip install -r requirements.txt # Local
+    $ pip install -r requirements_colab.txt # Google Colab
 
 
 P.S. Since Google Colab already comes with almost all necessary packages, you just need to install very few missing ones.

diff --git a/docs/source/guide/quick_start.rst b/docs/source/guide/quick_start.rst
@@ -1,5 +1,5 @@
 How can I run Ducho
-------------
+-------------------
 
 You may choose among three options:
 
@@ -20,6 +20,7 @@ In that case, if your machine is equipped with NVIDIA drivers, you should first
 For example, a possible working environment involves the following (you may refer to any Google Colab notebook):
 
 .. code:: bash
+
     Nvidia drivers: 525.85.12
     Cuda: 11.8.89
     Python: 3.11.2
@@ -40,6 +41,7 @@ Quite conveniently, you can find several CUDA-equipped images on Docker Hub. You
 To test if everything worked smoothly, pull and run a container from the following docker image through this command:
 
 .. code:: bash
+
     docker run --rm --gpus all nvidia/cuda:11.8.0-cudnn8-devel-ubuntu22.04 nvidia-smi