Skip to content

Fix documentation errors from PR #57 #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Joao-Paulo-Silva merged 1 commit into from
Apr 21, 2026
Merged

Fix documentation errors from PR #57 #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion aisp/csa/_ai_recognition_sys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class AIRS(BaseClassifier):
----------
n_resources : float, default=10
Total amount of available resources.
rate_clonal : float, default=10
rate_clonal : int, default=10
Maximum number of possible clones of a class. This quantity is multiplied by (
cell_stimulus * rate_hypermutation) to define the number of clones.
rate_mc_init : float, default=0.2
Expand Down
2 changes: 1 addition & 1 deletion aisp/nsa/_negative_selection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def fit(
verbose: bool = True,
) -> RNSA:
"""
Perform training according to X and y, using the negative selection method (NegativeSelect).
Perform training according to X and y, using the negative selection method (RNSA).

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion docs/en/api/csa/airs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Output:
| Name | Type | Default | Description |
|-----------------------------|---------|:-------------:|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `n_resources` | `float` | `10` | Total amount of available resources. |
| `rate_clonal` | `float` | `10` | Maximum number of possible clones of a class. This quantity is multiplied by (cell_stimulus * rate_hypermutation) to define the number of clones. |
| `rate_clonal` | `int` | `10` | Maximum number of possible clones of a class. This quantity is multiplied by (cell_stimulus * rate_hypermutation) to define the number of clones. |
| `rate_mc_init` | `float` | `0.2` | Percentage of samples used to initialize memory cells. |
| `rate_hypermutation` | `float` | `0.75` | The rate of mutated clones derived from rate_clonal as a scalar factor. |
| `affinity_threshold_scalar` | `float` | `0.75` | Normalized affinity threshold. |
Expand Down
2 changes: 1 addition & 1 deletion docs/en/api/nsa/rnsa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ print(y_pred)
| `algorithm` | `{"default-NSA", "V-detector"}` | `'default-NSA'` | Set the algorithm version |
| `non_self_label` | `str` | `'non-self'` | This variable stores the label that will be assigned when the data has only one output class, and the sample is classified as not belonging to that class. |
| `cell_bounds` | `bool` | `False` | If set to ``True``, this option limits the generation of detectors to the space within the plane between 0 and 1. This means that any detector whose radius exceeds this limit is discarded, this variable is only used in the ``V-detector`` algorithm. |
| `p` | `bool` | `2.0` | This parameter stores the value of `p` used in the Minkowski distance. |
| `p` | `float` | `2.0` | This parameter stores the value of `p` used in the Minkowski distance. |

## Attributes

Expand Down
2 changes: 1 addition & 1 deletion docs/pt-br/api/csa/airs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Output:
| Nome | Tipo | Default | Descrição |
|-----------------------------|---------|:-------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `n_resources` | `float` | `10` | Quantidade total de recursos disponíveis. |
| `rate_clonal` | `float` | `10` | Número máximo de clones possíveis de uma classe. Esta quantidade é multiplicada por (estímulo da célula * rate_hypermutation) para definir o número de clones. |
| `rate_clonal` | `int` | `10` | Número máximo de clones possíveis de uma classe. Esta quantidade é multiplicada por (estímulo da célula * rate_hypermutation) para definir o número de clones. |
| `rate_mc_init` | `float` | `0.2` | Porcentagem de amostras usadas para inicializar a população de células de memória. |
| `rate_hypermutation` | `float` | `0.75` | Taxa de clones mutados derivada de rate_clonal como um fator escalar. |
| `affinity_threshold_scalar` | `float` | `0.75` | Limiar de afinidade normalizado. |
Expand Down
2 changes: 1 addition & 1 deletion docs/pt-br/api/nsa/rnsa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ print(y_pred)
| `algorithm` | `{"default-NSA", "V-detector"}` | `'default-NSA'` | Define a versão do algoritmo. |
| `non_self_label` | `str` | `'non-self'` | Rótulo atribuído quando há apenas uma classe de saída e a amostra não pertence a essa classe. |
| `cell_bounds` | `bool` | `False` | Se definido como True, esta opção limita a geração dos detectores ao espaço do plano compreendido entre 0 e 1. Isso significa que qualquer detector cujo raio ultrapasse esse limite é descartado, e esta variável é usada exclusivamente no algoritmo `V-detector`. |
| `p` | `bool` | `2.0` | Valor de `p` utilizado na distância de Minkowski. |
| `p` | `float` | `2.0` | Valor de `p` utilizado na distância de Minkowski. |

## Atributos

Expand Down
Loading