Skip to content

Api Reference for Gitbook docs#1061

Merged
paulb-seldon merged 25 commits intomasterfrom
api-reference-docs
Oct 10, 2025
Merged

Api Reference for Gitbook docs#1061
paulb-seldon merged 25 commits intomasterfrom
api-reference-docs

Conversation

@paulb-seldon
Copy link
Collaborator

No description provided.

@paulb-seldon paulb-seldon marked this pull request as ready for review October 7, 2025 15:17
@@ -0,0 +1,232 @@
# `alibi.api.interfaces`
## Constants
### `logger`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually logger is an internal object, is it relevant to have it here?

**Returns**
- Type: `alibi.api.interfaces.Explanation`

## Functions
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JFYI: I don't this old documentation exposes this, it doesn't look helpful


### `MOVIESENTIMENT_URLS`
```python
MOVIESENTIMENT_URLS: list = ['https://storage.googleapis.com/seldon-datasets/sentence_polarity_v1/rt-pola...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why it's cut :suspect:

Parameters

----------
partial_index
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: just a minor formatting thing

How it's now:
Image

How it was:
Image

@@ -0,0 +1,222 @@
# `alibi.explainers.anchors.anchor_image`
## Constants
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm feeling that Constants (together with Logger) section shouldn't be exposed

perturbation(anchor: tuple, num_samples: int) -> Tuple[numpy.ndarray, numpy.ndarray]
```

Perturbs an image by altering the values of selected superpixels. If a dataset of image
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor formatting issue:
Image

@paulb-seldon paulb-seldon merged commit 99c3421 into master Oct 10, 2025
9 of 16 checks passed
@paulb-seldon paulb-seldon deleted the api-reference-docs branch October 17, 2025 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants