Update documentation

_sources/api/index.rst

@@ -6,5 +6,6 @@ This page contains auto-generated API reference documentation [#f1]_.
 .. toctree::
    :titlesonly:
 
+   /api/nebula/index
 
 .. [#f1] Created by `Enrique Tomás Martínez Beltrán <https://www.enriquetomasmb.com/>`_

_sources/api/nebula/addons/attacks/attacks/index.rst

@@ -1,14 +1,11 @@
-:py:mod:`nebula.addons.attacks.attacks`
-=======================================
+nebula.addons.attacks.attacks
+=============================
 
 .. py:module:: nebula.addons.attacks.attacks
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
@@ -19,15 +16,16 @@ Classes
    nebula.addons.attacks.attacks.DelayerAttack
 
 
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    nebula.addons.attacks.attacks.create_attack
 
 
+Module Contents
+---------------
 
 .. py:function:: create_attack(attack_name)
 
@@ -36,22 +34,23 @@ Functions
 
 .. py:class:: Attack
 
-
    .. py:method:: attack(received_weights)
       :abstractmethod:
 
+
       Function to perform the attack on the received weights. It should return the
       attacked weights.
 
 
 
 .. py:class:: GLLNeuronInversionAttack(strength=5.0, perc=1.0)
 
-
    Bases: :py:obj:`Attack`
 
+
    Function to perform neuron inversion attack on the received weights.
 
+
    .. py:method:: attack(received_weights)
 
       Function to perform the attack on the received weights. It should return the
@@ -61,11 +60,12 @@ Functions
 
 .. py:class:: NoiseInjectionAttack(strength=10000, perc=1.0)
 
-
    Bases: :py:obj:`Attack`
 
+
    Function to perform noise injection attack on the received weights.
 
+
    .. py:method:: attack(received_weights)
 
       Function to perform the attack on the received weights. It should return the
@@ -75,9 +75,9 @@ Functions
 
 .. py:class:: SwappingWeightsAttack(layer_idx=0)
 
-
    Bases: :py:obj:`Attack`
 
+
    Function to perform swapping weights attack on the received weights. Note that this
    attack performance is not consistent due to its stochasticity.
 
@@ -86,6 +86,7 @@ Functions
    Do not apply to last layer, as it would make the attack detectable (high loss
    on malicious node).
 
+
    .. py:method:: attack(received_weights)
 
       Function to perform the attack on the received weights. It should return the
@@ -95,12 +96,13 @@ Functions
 
 .. py:class:: DelayerAttack
 
-
    Bases: :py:obj:`Attack`
 
+
    Function to perform delayer attack on the received weights. It delays the
    weights for an indefinite number of rounds.
 
+
    .. py:method:: attack(received_weights)
 
       Function to perform the attack on the received weights. It should return the

_sources/api/nebula/addons/attacks/index.rst

@@ -1,24 +1,24 @@
-:py:mod:`nebula.addons.attacks`
-===============================
+nebula.addons.attacks
+=====================
 
 .. py:module:: nebula.addons.attacks
 
 
 Subpackages
 -----------
+
 .. toctree::
-   :titlesonly:
-   :maxdepth: 3
+   :maxdepth: 1
 
-   poisoning/index.rst
+   /api/nebula/addons/attacks/poisoning/index
 
 
 Submodules
 ----------
+
 .. toctree::
-   :titlesonly:
    :maxdepth: 1
 
-   attacks/index.rst
+   /api/nebula/addons/attacks/attacks/index
 
 

_sources/api/nebula/addons/attacks/poisoning/datapoison/index.rst

@@ -1,15 +1,11 @@
-:py:mod:`nebula.addons.attacks.poisoning.datapoison`
-====================================================
+nebula.addons.attacks.poisoning.datapoison
+==========================================
 
 .. py:module:: nebula.addons.attacks.poisoning.datapoison
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
@@ -18,6 +14,8 @@ Functions
    nebula.addons.attacks.poisoning.datapoison.poison_to_nlp_rawdata
 
 
+Module Contents
+---------------
 
 .. py:function:: datapoison(dataset, indices, poisoned_persent, poisoned_ratio, targeted=False, target_label=3, noise_type='salt')
 

_sources/api/nebula/addons/attacks/poisoning/index.rst

@@ -1,17 +1,17 @@
-:py:mod:`nebula.addons.attacks.poisoning`
-=========================================
+nebula.addons.attacks.poisoning
+===============================
 
 .. py:module:: nebula.addons.attacks.poisoning
 
 
 Submodules
 ----------
+
 .. toctree::
-   :titlesonly:
    :maxdepth: 1
 
-   datapoison/index.rst
-   labelflipping/index.rst
-   modelpoison/index.rst
+   /api/nebula/addons/attacks/poisoning/datapoison/index
+   /api/nebula/addons/attacks/poisoning/labelflipping/index
+   /api/nebula/addons/attacks/poisoning/modelpoison/index
 
 

_sources/api/nebula/addons/attacks/poisoning/labelflipping/index.rst

@@ -1,21 +1,19 @@
-:py:mod:`nebula.addons.attacks.poisoning.labelflipping`
-=======================================================
+nebula.addons.attacks.poisoning.labelflipping
+=============================================
 
 .. py:module:: nebula.addons.attacks.poisoning.labelflipping
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    nebula.addons.attacks.poisoning.labelflipping.labelFlipping
 
 
+Module Contents
+---------------
 
 .. py:function:: labelFlipping(dataset, indices, poisoned_persent=0, targeted=False, target_label=4, target_changed_label=7)
 

_sources/api/nebula/addons/attacks/poisoning/modelpoison/index.rst

@@ -1,21 +1,19 @@
-:py:mod:`nebula.addons.attacks.poisoning.modelpoison`
-=====================================================
+nebula.addons.attacks.poisoning.modelpoison
+===========================================
 
 .. py:module:: nebula.addons.attacks.poisoning.modelpoison
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    nebula.addons.attacks.poisoning.modelpoison.modelpoison
 
 
+Module Contents
+---------------
 
 .. py:function:: modelpoison(model, poisoned_ratio, noise_type='gaussian')
 

_sources/api/nebula/addons/blockchain/blockchain_deployer/index.rst

@@ -1,42 +1,35 @@
-:py:mod:`nebula.addons.blockchain.blockchain_deployer`
-======================================================
+nebula.addons.blockchain.blockchain_deployer
+============================================
 
 .. py:module:: nebula.addons.blockchain.blockchain_deployer
 
 
-Module Contents
----------------
-
-Classes
-~~~~~~~
+Attributes
+----------
 
 .. autoapisummary::
 
-   nebula.addons.blockchain.blockchain_deployer.BlockchainDeployer
-
-
+   nebula.addons.blockchain.blockchain_deployer.w3
+   nebula.addons.blockchain.blockchain_deployer.b
 
 
-Attributes
-~~~~~~~~~~
+Classes
+-------
 
 .. autoapisummary::
 
-   nebula.addons.blockchain.blockchain_deployer.w3
-   nebula.addons.blockchain.blockchain_deployer.b
+   nebula.addons.blockchain.blockchain_deployer.BlockchainDeployer
 
 
-.. py:data:: w3
+Module Contents
+---------------
 
-   
+.. py:data:: w3
 
 .. py:class:: BlockchainDeployer(n_validator=3, config_dir='.', input_dir='.')
 
-
    Creates files (docker-compose.yaml and genesis.json) for deploying blockchain network
 
 
 .. py:data:: b
 
-   
-

_sources/api/nebula/addons/blockchain/chaincode/index.rst

@@ -1,5 +1,5 @@
-:py:mod:`nebula.addons.blockchain.chaincode`
-============================================
+nebula.addons.blockchain.chaincode
+==================================
 
 .. py:module:: nebula.addons.blockchain.chaincode
 

_sources/api/nebula/addons/blockchain/geth/index.rst

@@ -1,5 +1,5 @@
-:py:mod:`nebula.addons.blockchain.geth`
-=======================================
+nebula.addons.blockchain.geth
+=============================
 
 .. py:module:: nebula.addons.blockchain.geth
 

_sources/api/nebula/addons/blockchain/index.rst

@@ -1,26 +1,26 @@
-:py:mod:`nebula.addons.blockchain`
-==================================
+nebula.addons.blockchain
+========================
 
 .. py:module:: nebula.addons.blockchain
 
 
 Subpackages
 -----------
+
 .. toctree::
-   :titlesonly:
-   :maxdepth: 3
+   :maxdepth: 1
 
-   chaincode/index.rst
-   geth/index.rst
-   oracle/index.rst
+   /api/nebula/addons/blockchain/chaincode/index
+   /api/nebula/addons/blockchain/geth/index
+   /api/nebula/addons/blockchain/oracle/index
 
 
 Submodules
 ----------
+
 .. toctree::
-   :titlesonly:
    :maxdepth: 1
 
-   blockchain_deployer/index.rst
+   /api/nebula/addons/blockchain/blockchain_deployer/index