e604611b9b
Add v2.6.6 to RELEASE_VERSIONS ( #1162 )
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.11 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-12 (push) Has been cancelled
CI / Test: Python 3.11 on macos-12 (push) Has been cancelled
CI / Test: Python 3.8 on macos-12 (push) Has been cancelled
CI / Test: Python 3.9 on macos-12 (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2024-06-25 19:27:43 +00:00
f447bf2cf0
Exclude notebook pattern for data_monitor.ipynb in docs ( #1161 )
2024-06-25 14:58:04 +00:00
d9f589ee26
Add table of issue type info and relevant column name descriptions ( #1100 )
...
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2024-06-06 15:25:39 +00:00
75a9d1c1b9
Add v2.6.5 to RELEASE_VERSIONS ( #1130 )
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.11 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-12 (push) Has been cancelled
CI / Test: Python 3.11 on macos-12 (push) Has been cancelled
CI / Test: Python 3.8 on macos-12 (push) Has been cancelled
CI / Test: Python 3.9 on macos-12 (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2024-05-24 21:48:07 +00:00
fda3413275
Bump cleanlab version to 2.6.5 post release ( #1121 )
2024-05-14 00:19:30 +00:00
b66a959547
Add v2.6.3 to RELEASE_VERSIONS ( #1058 )
CI / Lint Notebooks (push) Has been cancelled
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.11 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.11 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2024-03-19 19:08:40 +00:00
e42544894e
Add v2.6.2 to RELEASE_VERSIONS ( #1047 )
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.11 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.11 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2024-03-08 16:00:05 +00:00
f7f1d2241e
Update version for 2.6.1 release ( #1038 )
2024-03-06 18:51:25 +00:00
231ab6314d
List out issue names for each issue type in Datalab Issue Type Guide ( #1024 )
...
- Show how an issue name is used in Datalab.find_issues()
- Add sphinx_jinja as a dependency for using .rst-templates
2024-02-23 21:49:19 +00:00
3f07a88f92
update RELEASE_VERSIONS for docs conf.py ( #1017 )
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.11 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.11 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2024-02-16 06:16:45 +00:00
a8d2170f0d
add extention to docs for Open Graph metadata ( #881 )
2024-01-16 18:10:50 +00:00
d45537ea7d
Update RELEASE_VERSIONS for docs conf.py ( #846 )
CI / Test: Python 3.7 on windows (push) Has been cancelled
CI / Test: Python 3.10 on windows (push) Has been cancelled
CI / Test: Python 3.8 on windows (push) Has been cancelled
CI / Test: Python 3.9 on windows (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.7 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.7 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2023-09-11 07:44:09 -07:00
393a737a75
Add analytics for docs website ( #769 )
2023-07-13 07:03:16 -04:00
b94106b6c9
CI: set nbsphinx_allow_errors False ( #757 )
2023-06-28 10:17:58 -07:00
5830714663
update RELEASE_VERSIONS to include v2.4 ( #715 )
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.7 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.7 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.10 on windows-latest (push) Has been cancelled
CI / Test: Python 3.7 on windows-latest (push) Has been cancelled
CI / Test: Python 3.8 on windows-latest (push) Has been cancelled
CI / Test: Python 3.9 on windows-latest (push) Has been cancelled
CI / Test without optional dependencies and with minimum compatible versions of dependencies (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2023-05-12 18:47:26 -07:00
79cc3eb601
DOC: use default rules for shorter, more readable links ( #700 )
...
Co-authored-by: Hui Wen <45724323+huiwengoh@users.noreply.github.com >
2023-05-04 23:51:38 -04:00
036dcf3f95
Add testable example codeblock to functions in the dataset module ( #668 )
...
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
Co-authored-by: Elías Snorrason <eliassno@gmail.com >
2023-05-03 01:28:19 +00:00
7519e5d1f2
update version for 2.3.1 release ( #658 )
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.7 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.7 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.10 on windows-latest (push) Has been cancelled
CI / Test: Python 3.7 on windows-latest (push) Has been cancelled
CI / Test: Python 3.8 on windows-latest (push) Has been cancelled
CI / Test: Python 3.9 on windows-latest (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2023-03-27 23:25:24 -07:00
b8c034f34f
add 2.3.0 to release versions ( #644 )
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.7 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.7 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.10 on windows-latest (push) Has been cancelled
CI / Test: Python 3.7 on windows-latest (push) Has been cancelled
CI / Test: Python 3.8 on windows-latest (push) Has been cancelled
CI / Test: Python 3.9 on windows-latest (push) Has been cancelled
CI / Type check (push) Has been cancelled
CI / Format (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2023-03-01 01:02:29 -08:00
75bac0a284
Specify Sphinx to order functions by source code order ( #571 )
...
also re-order rank.py functions by moving specific types of label-quality scores to be last in file
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2022-12-22 09:14:44 -08:00
5a8619a274
Add v2.2.0 to RELEASE_VERSIONS in html_context ( #552 )
CI / Format (push) Has been cancelled
CI / Test: Python 3.10 on macos-latest (push) Has been cancelled
CI / Test: Python 3.6 on macos-latest (push) Has been cancelled
CI / Test: Python 3.7 on macos-latest (push) Has been cancelled
CI / Test: Python 3.8 on macos-latest (push) Has been cancelled
CI / Test: Python 3.9 on macos-latest (push) Has been cancelled
CI / Check for unused/wildcard imports (push) Has been cancelled
CI / Test: Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.6 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.7 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.8 on ubuntu-latest (push) Has been cancelled
CI / Test: Python 3.9 on ubuntu-latest (push) Has been cancelled
CI / Lint Notebooks (push) Has been cancelled
CI / Test: Python 3.10 on windows-latest (push) Has been cancelled
CI / Test: Python 3.6 on windows-latest (push) Has been cancelled
CI / Test: Python 3.7 on windows-latest (push) Has been cancelled
CI / Test: Python 3.8 on windows-latest (push) Has been cancelled
CI / Test: Python 3.9 on windows-latest (push) Has been cancelled
CI / Type check (push) Has been cancelled
GitHub Markdown Links / test (push) Has been cancelled
2022-11-28 15:47:15 +00:00
28446e949e
Pass docs versions as context variables to jinja ( #482 )
...
This replaces the fix in #480 .
2022-09-22 21:05:12 +00:00
d8cc2e5056
Fix details disclosure elements in docs ( #456 )
...
This patch makes the following fixes:
- Make summary text appear on the same line as the ">" arrow marker;
prior to this patch, it was being pushed down to the next line because
there were nested block elements inside the <summary> element
- Style details element to visually delineate collapsible content with
dashed lines above and below the content
- Add syntax highlighting for code blocks in details disclosure elements
(some were missing syntax highlighting)
- Hide a cell that was meant to be hidden in the audio tutorial
The summary element looked ugly due to a block element being present
inside the <summary>. This was present in the rendered docs even though
it was not explicitly in the source. Even though our source (in a
Markdown cell in a Jupyter notebook) looked like:
<summary>Example text</summary>
The rendered docs had:
<summary><p>Example text</p></summary>
The easy fix was to leave this as-is and fix the styling with CSS,
making all elements inside the summary to be displayed as inline
elements.
Where was the extra <p> tag coming from? Different Markdown parsers
handle mixed Markdown/HTML differently. We are using nbsphinx, which
does something especially weird [1]: converting from Markdown ->
reStructuredText -> HTML.
For example, consider the following Markdown:
<details><summary>Summary</summary>
Body.
</details>
nbsphinx was first converting it to this reST:
.. raw:: html
<details>
.. raw:: html
<summary>
Summary
.. raw:: html
</summary>
Body.
.. raw:: html
</details>
And then this reST was being converted to HTML. This is where the extra
<p> was coming from.
One workaround for this behavior is to switch to raw HTML cells in the
notebook, rather than Markdown cells, and write pure HTML there. This
has the disadvantage that it's inconvenient when the content inside the
<details> has extra markup: Markdown is very convenient for that (e.g.,
for styling text), and having the contents being parsed as Markdown also
allows us to easily use syntax highlighting inside the body.
Another workaround is to use raw reST cells [2] and write the proper
reST directly (avoiding the bad Markdown -> reST conversion). This
preserves the ability to use convenient formatting (though with reST
instead of Markdown) as well as syntax-highlighted code blocks. For
example:
.. raw:: html
<details><summary>Summary</summary>
.. code-block:: python
def meaning_of_life():
return 42
.. raw:: html
</details>
The above snippet produces the expected HTML, with syntax-highlighted
code in the body, and without the extra <p> inside the <summary>.
Rather than either of these workarounds, the most convenient one for
developers is to fix the issue using CSS, so that the Markdown cells in
the tutorials can be left as-is and no special care is required when
writing details disclosure elements, which is what this patch does.
[1]: https://github.com/spatialaudio/nbsphinx/blob/fc79fd1ac5ab6df225b256ef4ca203c58c5ad92b/src/nbsphinx.py#L1309
[2]: https://nbsphinx.readthedocs.io/en/0.8.9/raw-cells.html#reST
2022-09-16 12:11:05 -07:00
968310af37
Strip input prompts when copying code snippets ( #439 )
...
Configuration provided in https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers
2022-09-14 14:06:04 +00:00
729c9f3068
Add autodoc-typehints extension for sphinx ( #412 )
...
* add autodoc-typehints extension for sphinx
With the extension: Function parameters are auto-tagged in docs, based on the function signatures.
Resolves #398
* disable use of :rtype: role by napoleon
output return type inline with description (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html#sphinxcontrib.napoleon.Config.napoleon_use_rtype )
2022-09-13 13:12:28 -07:00
6eca467809
Remove unneeded alt text
...
The anchor already says "Run in Google Colab", so if the logo fails to
load, it will say "Google Colab Logo Run in Google Colab"; it's better
to have the alt text just be empty.
2022-04-18 08:10:44 -06:00
d7c128cd93
Final docs polishing patches ( #223 )
...
* plot_examples named with can skip
* respecify auto overflow handling
2022-04-16 15:46:32 -07:00
766c13b646
Make dataset tutorial runnable on website docs, improve pulldown formatting ( #220 )
...
* tutorial runnable on website, pulldown formatting
* add note re pulldown for colab users
* darkDF, remove auto-overflow handling
* tell colab users they can ignore bottom checks
2022-04-16 14:56:44 -07:00
3f51b3ef0f
Update doc conf.py
2022-04-15 15:52:40 -07:00
cff29fa0f3
Modify docs conf.py
2022-04-15 11:51:13 -07:00
bf8e82d4bf
Add support for LaTeX math in documentation
2022-04-09 07:33:24 -04:00
9c6ce93413
add gh icon to title
2022-04-09 03:21:05 +08:00
f8fe3fe9ee
Merge pull request #185 from anishathalye/fast-docs
...
Add more ergonomic method to skip notebooks
2022-04-07 12:14:26 -07:00
c8635bb50c
Add more ergonomic method to skip notebooks
...
This way, developers don't have to edit a file and remember to change it
back before submitting a pull request: that seems error-prone.
2022-04-07 05:53:54 -04:00
faac915740
mv example_models -> experimental
2022-04-07 01:25:03 -07:00
034eb80061
Change .ipynb files to use master ver of cleanlab
2022-03-27 17:45:05 +08:00
da686a4006
update doc toc for 2.0
2022-03-24 03:28:14 +08:00
aca683ec80
Add image classification tutorial and streamline docs CI/CD ( #127 )
2022-03-22 19:34:27 -04:00
8f9f3f5380
Major API change. Introducing Cleanlab 2.0 ( #128 )
...
* Refactor modules pruning to filter and latent_estimation to count
* Remove polyplex (research) algorithms from cleanlab
* Create new module rank and move scoring functions to rank.
* Rename test to match new module names
* Fixed error in normalized margin. added ranking for arbitrary psx and labels.
* Remove unused tests and methods. add multi-label support for baseline.
* Move baseline methods to filter and delete baseline module.
* change filter.get_noise_indices to filter.find_label_issues
* Rename baseline methods. fill out docstrings.
* Only require 1 example to be left in each class after removing errors. (instead of 5)
* Remove K as a parameter to count.compute_confident_joint
* Add C_argmax and C_ij methods from CL paper to find_label_issues
* Add warnings for new prune methods and frac_noise. Fix tests.
* Add baseline tests to test_rank_filter and delete baseline test
* Remove inverse_noise_matrix parameter in classification call to find_label_issues
* add todo to update docstring with new ranking functions
* 100% tests pass. add multi-label support for prune_method
* Major NOT-backwards-compatible name changes to most components
* More Major NOT-backwards-compatible name changes
* fixed s -> label mistakes
* Several nomenclature updates from PR feedback. models renamed to example models.
* Remove python2 support across all modules.
* major api changes. psx -> pred_probs. prob_given_label -> self_confidence. testing added.
* enable python version 3.9 for pytorch model.
* ran spellcheck
* ran grammar check
* Update count.py
* Update filter.py
* Update setup.py and ci.yml to no longer support Python 2 and py3.4/5
* Increase test coverage and documentation of rank module methods.
* create utils submodule and move util and latent_algebra
* Rename y everywhere to true_labels, and p(true_label=..)
* Enforce positional arguments in methods. Fully remove py2 support.
2022-03-16 06:52:03 -04:00
6169fdcd43
Add new documentation site
2022-03-01 14:55:51 -05:00
Elías Snorrason