Install alibi-detect during RTD docs build #499
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the ReadTheDocs V2 config file it appears we can install
alibi-detect
(and its dependencies) as part of the docs build, so that they don't have to be mocked. This is a bit of a waste of compute whilst we have heavy core deps liketensorflow
, but once the optional deps project is complete we can investigate installingalibi-detect
on RTD and only mocking heavy optional deps (e.g.tensorflow
,torch
). This would ease pain points experienced when building the API docs involving some mocked modules such aspydantic
.Opening this PR now to come back to once the optional deps project is complete.
If going ahead with this we'd likely have to configure
:inherited-members:
to prevent docstrings of inherited modules being included when we don't want them to e.g. see example here.