Skip to content

Conversation

@pyup-bot
Copy link
Contributor

@pyup-bot pyup-bot commented Sep 2, 2024

Update sphinx from 7.3.7 to 8.0.2.

Changelog

8.0.2

=====================================

Bugs fixed
----------

* Fix the ``pygments.Formatter.__class_getitem__`` patch.
Patch by Adam Turner.

8.0.1

=====================================

Bugs fixed
----------

* Patch ``pygments.Formatter.__class_getitem__`` in Pygments 2.17.
Patch by Adam Turner.

8.0.0

=====================================

Dependencies
------------

* 12633: Drop Python 3.9 support.

Incompatible changes
--------------------

.. rst-class:: compact

* Remove deprecated functions from ``sphinx.util``:

* Removed ``sphinx.util.path_stabilize``
 (use ``sphinx.util.osutil.path_stabilize``).
* Removed ``sphinx.util.display_chunk``
 (use ``sphinx.util.display.display_chunk``).
* Removed ``sphinx.util.status_iterator``
 (use ``sphinx.util.display.status_iterator``).
* Removed ``sphinx.util.SkipProgressMessage``
 (use ``sphinx.util.display.SkipProgressMessage``).
* Removed ``sphinx.util.progress_message``
 (use ``sphinx.util.display.progress_message``).
* Removed ``sphinx.util.epoch_to_rfc1123``
 (use ``sphinx.http_date.epoch_to_rfc1123``).
* Removed ``sphinx.util.rfc1123_to_epoch``
 (use ``sphinx.http_date.rfc1123_to_epoch``).
* Removed ``sphinx.util.save_traceback``
 (use ``sphinx.exceptions.save_traceback``).
* Removed ``sphinx.util.format_exception_cut_frames``
 (use ``sphinx.exceptions.format_exception_cut_frames``).
* Removed ``sphinx.util.xmlname_checker``
 (use ``sphinx.builders.epub3._XML_NAME_PATTERN``).

Patch by Adam Turner.
* Removed :py:func:`!sphinx.util.osutil.cd`
(use :py:func:`contextlib.chdir`).
Patch by Adam Turner.
* Removed :py:func:`!sphinx.util.typing.stringify`
(use :py:func:`!sphinx.util.typing.stringify_annotation`).
Patch by Adam Turner.
* 12593: Raise an error for invalid :confval:`html_sidebars` values.
Patch by Adam Turner.
* 12593: Raise an error in :py:func:`!Theme.get_config` for invalid sections.
Patch by Adam Turner.
* 11693: Remove support for old-style :file:`Makefile` and :file:`make.bat`
output in :program:`sphinx-quickstart`.
* 11693: Remove the :option:`!--no-use-make-mode`, :option:`!-M`,
:option:`!--use-make-mode`, and :option:`!-m` options
from :program:`sphinx-quickstart`.
Patch by Adam Turner.
* Removed the tuple interface to :py:class:`!sphinx.ext.autodoc.ObjectMember`.
Patch by Adam Turner.
* 12630: Sphinx 8 makes two changes to the ``linkcheck`` configuration defaults:

* :confval:`linkcheck_allow_unauthorized` is now ``False`` by default.
* :confval:`linkcheck_report_timeouts_as_broken` is now ``False`` by default.

Patch by James Addison.
* 12597: Change the default of :confval:`show_warning_types`
from ``False`` to ``True``.
Patch by Chris Sewell.
* 12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
:confval:`intersphinx_mapping` format.
Patch by Bénédikt Tran and Adam Turner.
* 12096: Do not overwrite user-supplied files when copying assets
unless forced with ``force=True``.
Patch by Adam Turner.
* 12646: Remove :py:func:`!sphinx.util.inspect.isNewType`.
Use ``isinstance(obj, typing.NewType)`` instead on Python 3.10 and newer.
Patch by Adam Turner.
* Remove the long-deprecated (since Sphinx 2) alias
to :py:class:`!VersionChange` in
:py:mod:`!sphinx.directives.other`
(Deprecated since Sphinx 2).
Use :py:class:`!sphinx.domains.changeset.VersionChange` directly.
Patch by Adam Turner.

Deprecated
----------

* 12643: Renamed ``sphinx.ext.intersphinx.normalize_intersphinx_mapping``
to ``sphinx.ext.intersphinx.validate_intersphinx_mapping``.
The old name will be removed in Sphinx 10.
Patch by Adam Turner.
* 12650, 12686, 12690: Extend the deprecation for string methods on
:py:class:`~pathlib.Path` objects to Sphinx 9.
Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
or :py:class:`~pathlib.Path`'s methods to work with path objects.
Patch by Adam Turner.

7.4.7

=====================================

Bugs fixed
----------

* 12096: Warn when files are overwritten in the build directory.
Patch by Adam Turner and Bénédikt Tran.
* 12620: Ensure that old-style object description options are respected.
Patch by Adam Turner.
* 12601, 12625: Support callable objects in :py:class:`~typing.Annotated` type
metadata in the Python domain.
Patch by Adam Turner.
* 12601, 12622: Resolve :py:class:`~typing.Annotated` warnings with
``sphinx.ext.autodoc``,
especially when using :mod:`dataclasses` as type metadata.
Patch by Adam Turner.
* 12589, 12626: autosummary: Fix warnings with :rst:role:`!autolink`.
Patch by Adam Turner.

7.4.6

=====================================

Bugs fixed
----------

* 12589, 9743, 12609: autosummary: Do not add the package prefix when
generating autosummary directives for modules within a package.
Patch by Adam Turner.
* 12613: Reduce log severity for ambiguity detection during inventory loading.
Patch by James Addison.

7.4.5

=====================================

Bugs fixed
----------

* 12593, 12600: Revert coercing the type of selected :confval:`html_sidebars`
values to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
* 12594: LaTeX: since 7.4.0, :rst:dir:`seealso` and other "light" admonitions
now break PDF builds if they contain a :dudir:`figure` directive; and also
if they are contained in a table cell (rendered by ``tabulary``).
Patch by Jean-François B.

7.4.4

=====================================

Bugs fixed
----------

* 12585, 12586: Do not warn when an intersphinx inventory contains
case-insensitively ambiguous duplicate items.
Patch by James Addison.

7.4.3

=====================================

Bugs fixed
----------

* 12582: Restore support for list-styled :confval:`source_suffix` values
with extensions that register parsers.
Patch by Adam Turner.

7.4.2

=====================================

Bugs fixed
----------

* 12580, 12583: Resolve failures with the C domain on incremental builds
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.

7.4.1

=====================================

Bugs fixed
----------

* Fix invalid HTML when a rubric node with invalid ``heading-level`` is used.
Patch by Adam Turner.
* 12579, 12581: Restore support for ``typing.ParamSpec`` in autodoc.
Patch by Adam Turner.

7.4.0

=====================================

Dependencies
------------

* 12555: Drop Docutils 0.18.1 and Docutils 0.19 support.
Patch by Adam Turner.
* LaTeX: the ``xcolor`` package is now required (but is for example part of
Ubuntu ``texlive-latex-recommended`` which has always been required).
* LaTeX: the ``fontawesome5`` LaTeX package is needed for the default choices
of icons now used in admonition titles in PDF output; but if unavailable the
PDF build will simply silently omit rendering such icons.  Check the
documentation of the ``iconpackage`` key of :ref:`'sphinxsetup'
<latexsphinxsetup>` for more.

Deprecated
----------

* LaTeX: the ``sphinxlightbox`` environment is not used anymore, all types
of admonitions use (by default) only ``sphinxheavybox``.

Features added
--------------

.. rst-class:: compact

* 11165: Support the `officially recommended`_ ``.jinja`` suffix for template
files.
Patch by James Addison and Adam Turner

.. _officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension
* 12325: Flatten ``Union[Literal[T], Literal[U], ...]`` to ``Literal[T, U, ...]``
when turning annotations into strings.
Patch by Adam Turner.
* 12319: ``sphinx.ext.extlinks``: Add ``extlink-{name}`` CSS class to links.
Patch by Hugo van Kemenade.
* 12387: Improve CLI progress message, when copying assets.
Patch by INADA Nakoi and Bénédikt Tran.
* 12361: Add :attr:`.BuildEnvironment.parser`.
Patch by Chris Sewell.
* 12358: Add :attr:`.Sphinx.fresh_env_used`.
Patch by Chris Sewell.
* 12329: Add detection of ambiguous ``std:label`` and ``std:term`` references during
loading and resolution of Intersphinx targets.
Patch by James Addison.
* 12422: Do not duplicate "navigation" in aria-label of built-in themes.
Patch by Thomas Weißschuh
* 12421: Include project name in ``logo_alt`` of built-in themes.
Patch by Thomas Weißschuh
* 12448: Add :option:`sphinx-apidoc --remove-old` option.
Patch by Chris Sewell.
* 12456: Add :option:`sphinx-autogen --remove-old` option.
Patch by Chris Sewell.
* 12479: Add warning subtype ``toc.no_title``.
Patch by Ondřej Navrátil.
* 12492: Add helper methods for parsing reStructuredText content into nodes from
within a directive.

- :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes()`
 parses the directive's content and returns a list of Docutils nodes.
- :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes()`
 parses the provided text and returns a list of Docutils nodes.
- :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_inline()`
 parses the provided text into inline elements and text nodes.

Patch by Adam Turner.
* 12258: Support ``typing_extensions.Unpack``
Patch by Bénédikt Tran and Adam Turner.
* 12524: Add a ``class`` option to the :rst:dir:`toctree` directive.
Patch by Tim Hoffmann.
* 12536: Add the :rst:dir:`confval` directive.
Patch by Adam Turner.
* 12537: :confval:`c_id_attributes`, :confval:`c_paren_attributes`,
:confval:`cpp_id_attributes`, and :confval:`cpp_paren_attributes`
can now be a tuple of strings.
:confval:`c_extra_keywords`, :confval:`gettext_additional_targets`,
:confval:`html_domain_indices`, :confval:`latex_domain_indices`,
and :confval:`texinfo_domain_indices`,
can now be a set of strings.
Patch by Adam Turner.
* 12523: Added configuration option, :confval:`math_numsep`, to define the
separator for math numbering.
Patch by Thomas Fanning
* 11592: Add :confval:`coverage_modules` to the coverage builder
to allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane.
* 7896, 11989: Add a :rst:dir:`py:type` directive for documenting type aliases,
and a :rst:role:`py:type` role for linking to them.
Patch by Ashley Whetter.
* 12549: Add optional ``description`` argument to
:meth:`.Sphinx.add_config_value`.
Patch by Chris Sewell.
* 6792: Prohibit module import cycles in :mod:`sphinx.ext.autosummary`.
Patch by Trevor Bekolay.
* 12508: LaTeX: Revamped styling of all admonitions, with addition of a
title row with icon.
Patch by Jean-François B.
* 11773: Display :py:class:`~typing.Annotated` annotations
with their metadata in the Python domain.
Patch by Adam Turner and David Stansby.
* 12506: Add ``heading-level`` option to :rst:dir:`rubric` directive.
Patch by Chris Sewell.
* 12567: Add the :event:`write-started` event.
Patch by Chris Sewell.

Bugs fixed
----------

* 12314: Properly format ``collections.abc.Callable`` in annotations.
Patch by Adam Turner.
* 12162: Fix a performance regression in the C domain that has
been present since version 3.0.0.
Patch by Donald Hunter.
* 12320: Fix removal of anchors from search summaries (regression in 7.3.0).
Patch by Will Lachance.
* 12251: Fix ``merge_domaindata()`` in ``sphinx.ext.duration``.
Patch by Matthias Geier.
* 12224: Properly detect WebP files.
Patch by Benjamin Cabé.
* 12380: LaTeX: Avoid footnote markers ``Page N`` when ``N`` is already
the current page number.
Patch by Jean-François B.
* 12410: LaTeX: for French and ``'lualatex'`` as :confval:`latex_engine`
use ``babel`` as with ``'xelatex'`` (and not ``polyglossia``).
Patch by Jean-François B.
* 12520: LaTeX: let :rst:dir:`todolist` produce correct hyperlinks in PDF.
Patch by Jean-François B.
* 12416: Ensure that configuration setting aliases are always synchronised
when one value or the other is modified.
Patch by Bénédikt Tran.
* 12220: Fix loading custom template translations for ``en`` locale.
Patch by Nicolas Peugnet.
* 12459: Add valid-type arguments to the ``linkcheck_rate_limit_timeout``
configuration setting.
Patch by James Addison.
* 12331: Resolve data-URI-image-extraction regression from v7.3.0 affecting
builders without native support for data-URIs in their output format.
Patch by James Addison.
* 12494: Fix invalid genindex.html file produced with translated docs
(regression in 7.1.0).
Patch by Nicolas Peugnet.
* 11961: Omit anchor references from document title entries in the search index,
removing duplication of search results.
Patch by James Addison.
* 12425: Use Docutils' SVG processing in the HTML builder
and remove Sphinx's custom logic.
Patch by Tunç Başar Köse.
* 12391: Adjust scoring of matches during HTML search so that document main
titles tend to rank higher than subsection titles. In addition, boost matches
on the name of programming domain objects relative to title/subtitle matches.
Patch by James Addison and Will Lachance.
* 9634: Do not add a fallback language by stripping the country code.
Patch by Alvin Wong.
* 12352: Add domain objects to the table of contents
in the same order as defined in the document.
Previously, each domain used language-specific nesting rules,
which removed control from document authors.
Patch by Jakob Lykke Andersen and Adam Turner.
* 11041: linkcheck: Ignore URLs that respond with non-Unicode content.
Patch by James Addison.
* 12543: Fix :pep:`695` formatting for LaTeX output.
Patch by Bénédikt Tran.

Testing
-------

* karma: refactor HTML search tests to use fixtures generated by Sphinx.
Patch by James Addison.
Links

Update furo from 2024.5.6 to 2024.8.6.

Changelog

2024.08.06

- ✨ Add support for Sphinx 8
- ✨ Add smoother transitions between breakpoints
- Increase specificity of table-wrapper selector
- Avoid page breaks inside paragraphs

2024.07.18

- Improve how icons are handled and aligned.
- Improve scroll event handler.
- Hide the copybutton by default.
- Fix `source_view_link` configuration handling.
- Fix close tag on pencil icon.
Links

Update setuptools from 70.0.0 to 74.0.0.

Changelog

74.0.0

=======

Features
--------

- Changed the type of error raised by ``setuptools.command.easy_install.CommandSpec.from_param`` on unsupported argument from `AttributeError` to `TypeError` -- by :user:`Avasam` (4548)
- Added detection of ARM64 variant of MSVC -- by :user:`saschanaz` (4553)
- Made ``setuptools.package_index.Credential`` a `typing.NamedTuple` -- by :user:`Avasam` (4585)
- Reraise error from ``setuptools.command.easy_install.auto_chmod`` instead of nonsensical ``TypeError: 'Exception' object is not subscriptable`` -- by :user:`Avasam` (4593)
- Fully typed all collection attributes in ``pkg_resources`` -- by :user:`Avasam` (4598)
- Automatically exclude ``.tox|.nox|.venv`` directories from ``sdist``. (4603)


Deprecations and Removals
-------------------------

- Removed the monkeypatching of distutils._msvccompiler. Now all compiler logic is consolidated in distutils. (4600)
- Synced with pypa/distutils58fe058e4, including consolidating Visual Studio 2017 support (4600, pypa/distutils289), removal of deprecated legacy MSVC compiler modules (pypa/distutils287), suppressing of errors when the home directory is missing (pypa/distutils278), removal of wininst binaries (pypa/distutils282). (4606)


Misc
----

- 4592

73.0.1

=======

Bugfixes
--------

- Remove `abc.ABCMeta` metaclass from abstract classes. `pypa/setuptools4503 <https://github.com/pypa/setuptools/pull/4503>`_ had an unintended consequence of causing potential ``TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases`` -- by :user:`Avasam` (#4579)

73.0.0

=======

Features
--------

- Mark abstract base classes and methods with `abc.ABC` and `abc.abstractmethod` -- by :user:`Avasam` (4503)
- Changed the order of type checks in ``setuptools.command.easy_install.CommandSpec.from_param`` to support any `collections.abc.Iterable` of `str` param -- by :user:`Avasam` (4505)


Bugfixes
--------

- Prevent an error in ``bdist_wheel`` if ``compression`` is set to a `str` (even if valid) after finalizing options but before running the command. -- by :user:`Avasam` (4383)
- Raises an exception when ``py_limited_api`` is used in a build with
``Py_GIL_DISABLED``. This is currently not supported (python/cpython111506). (4420)
- Synced with pypa/distutils30b7331 including fix for modified check on empty sources (pypa/distutils284).


Deprecations and Removals
-------------------------

- ``setuptools`` is replacing the usages of :pypi:`ordered_set` with simple
instances of ``dict[Hashable, None]``. This is done to remove the extra
dependency and it is possible because since Python 3.7, ``dict`` maintain
insertion order. (4574)


Misc
----

- 4534, 4546, 4554, 4559, 4565

72.2.0

=======

Features
--------

- Merged with pypa/distutilsb7ee725f3 including: Support for Pathlike objects in data files and extensions (pypa/distutils272, pypa/distutils237), native support for C++ compilers (pypa/distuils228) and removed unused get_msvcr() (pypa/distutils274). (4538)

72.1.0

=======

Features
--------

- Restore the tests command and deprecate access to the module. (4519) (4520)

72.0.0

=======

Deprecations and Removals
-------------------------

- The test command has been removed. Users relying on 'setup.py test' will need to migrate to another test runner or pin setuptools before this version. (931)

71.1.0

=======

Features
--------

- Added return types to typed public functions -- by :user:`Avasam`

Marked `pkg_resources` as ``py.typed`` -- by :user:`Avasam` (4409)


Misc
----

- 4492

71.0.4

=======

Bugfixes
--------

- Removed lingering unused code around Distribution._patched_dist. (4489)

71.0.3

=======

Bugfixes
--------

- Reset the backports module when enabling vendored packages. (4476)

71.0.2

=======

Bugfixes
--------

- Include all vendored files in the sdist. (4480)

71.0.1

=======

Bugfixes
--------

- Restored package data that went missing in 71.0. This change also incidentally causes tests to be installed once again. (4475)

71.0.0

=======

Deprecations and Removals
-------------------------

- Now setuptools declares its own dependencies in the ``core`` extra. Dependencies are still vendored for bootstrapping purposes, but setuptools will prefer installed dependencies if present. The ``core`` extra is used for informational purposes and should *not* be declared in package metadata (e.g. ``build-requires``). Downstream packagers can de-vendor by simply removing the ``setuptools/_vendor`` directory. Since Setuptools now prefers installed dependencies, those installing to an environment with old, incompatible dependencies will not work. In that case, either uninstall the incompatible dependencies or upgrade them to satisfy those declared in ``core``. (2825)

70.3.0

=======

Features
--------

- Support for loading distutils from the standard library is now deprecated, including use of SETUPTOOLS_USE_DISTUTILS=stdlib and importing distutils before importing setuptools. (4137)


Bugfixes
--------

- Bugfix for building Cython extension on Windows (pypa/distutils268).

70.2.0

=======

Features
--------

- Updated distutils including significant changes to support Cygwin and mingw compilers. (4444)


Bugfixes
--------

- Fix distribution name normalisation (:pep:`625`) for valid versions that are
not canonical (e.g. ``1.0-2``). (4434)

70.1.1

=======

Misc
----

- 4429

70.1.0

=======

Features
--------

- Adopted the ``bdist_wheel`` command from the ``wheel`` project -- by :user:`agronholm` (1386)
- Improve error message when ``pkg_resources.ZipProvider`` tries to extract resources with a missing Egg -- by :user:`Avasam`

Added variables and parameter type annotations to ``pkg_resources`` to be nearly on par with typeshed.\* -- by :user:`Avasam`
\* Excluding ``TypeVar`` and ``overload``. Return types are currently inferred. (4246)
- Migrated Setuptools' own config to pyproject.toml (4310)


Bugfixes
--------

- Prevent a ``TypeError: 'NoneType' object is not callable`` when ``shutil_rmtree`` is called without an ``onexc`` parameter on Python<=3.11 -- by :user:`Avasam` (4382)
- Replace use of mktemp with can_symlink from the stdlib test suite. (4403)
- Improvement for ``attr:`` directives in configuration to handle
more edge cases related to complex ``package_dir``. (4405)
- Fix accidental implicit string concatenation. (4411)


Misc
----

- 4365, 4422
Links

Update pytest from 8.2.1 to 8.3.2.

Changelog

8.3.1

=========================

The 8.3.0 release failed to include the change notes and docs for the release. This patch release remedies this. There are no other changes.

8.3.0

=========================

New features
------------

- `12231 <https://github.com/pytest-dev/pytest/issues/12231>`_: Added `--xfail-tb` flag, which turns on traceback output for XFAIL results.

* If the `--xfail-tb` flag is not given, tracebacks for XFAIL results are NOT shown.
* The style of traceback for XFAIL is set with `--tb`, and can be `auto|long|short|line|native|no`.
* Note: Even if you have `--xfail-tb` set, you won't see them if `--tb=no`.

Some history:

With pytest 8.0, `-rx` or `-ra` would not only turn on summary reports for xfail, but also report the tracebacks for xfail results. This caused issues with some projects that utilize xfail, but don't want to see all of the xfail tracebacks.

This change detaches xfail tracebacks from `-rx`, and now we turn on xfail tracebacks with `--xfail-tb`. With this, the default `-rx`/ `-ra` behavior is identical to pre-8.0 with respect to xfail tracebacks. While this is a behavior change, it brings default behavior back to pre-8.0.0 behavior, which ultimately was considered the better course of action.

-- by :user:`okken`


- `12281 <https://github.com/pytest-dev/pytest/issues/12281>`_: Added support for keyword matching in marker expressions.

Now tests can be selected by marker keyword arguments.
Supported values are :class:`int`, (unescaped) :class:`str`, :class:`bool` & :data:`None`.

See :ref:`marker examples <marker_keyword_expression_example>` for more information.

-- by :user:`lovetheguitar`


- `12567 <https://github.com/pytest-dev/pytest/issues/12567>`_: Added ``--no-fold-skipped`` command line option.

If this option is set, then skipped tests in short summary are no longer grouped
by reason but all tests are printed individually with their nodeid in the same
way as other statuses.

-- by :user:`pbrezina`



Improvements in existing functionality
--------------------------------------

- `12469 <https://github.com/pytest-dev/pytest/issues/12469>`_: The console output now uses the "third-party plugins" terminology,
replacing the previously established but confusing and outdated
reference to :std:doc:`setuptools <setuptools:index>`
-- by :user:`webknjaz`.


- `12544 <https://github.com/pytest-dev/pytest/issues/12544>`_, `#12545 <https://github.com/pytest-dev/pytest/issues/12545>`_: Python virtual environment detection was improved by
checking for a :file:`pyvenv.cfg` file, ensuring reliable detection on
various platforms -- by :user:`zachsnickers`.


- `2871 <https://github.com/pytest-dev/pytest/issues/2871>`_: Do not truncate arguments to functions in output when running with `-vvv`.


- `389 <https://github.com/pytest-dev/pytest/issues/389>`_: The readability of assertion introspection of bound methods has been enhanced
-- by :user:`farbodahm`, :user:`webknjaz`, :user:`obestwalter`, :user:`flub`
and :user:`glyphack`.

Earlier, it was like:

.. code-block:: console

   =================================== FAILURES ===================================
   _____________________________________ test _____________________________________

       def test():
   >       assert Help().fun() == 2
   E       assert 1 == 2
   E        +  where 1 = <bound method Help.fun of <example.Help instance at 0x256a830>>()
   E        +    where <bound method Help.fun of <example.Help instance at 0x256a830>> = <example.Help instance at 0x256a830>.fun
   E        +      where <example.Help instance at 0x256a830> = Help()

   example.py:7: AssertionError
   =========================== 1 failed in 0.03 seconds ===========================


And now it's like:

.. code-block:: console

   =================================== FAILURES ===================================
   _____________________________________ test _____________________________________

       def test():
   >       assert Help().fun() == 2
   E       assert 1 == 2
   E        +  where 1 = fun()
   E        +    where fun = <test_local.Help object at 0x1074be230>.fun
   E        +      where <test_local.Help object at 0x1074be230> = Help()

   test_local.py:13: AssertionError
   =========================== 1 failed in 0.03 seconds ===========================


- `7662 <https://github.com/pytest-dev/pytest/issues/7662>`_: Added timezone information to the testsuite timestamp in the JUnit XML report.



Bug fixes
---------

- `11706 <https://github.com/pytest-dev/pytest/issues/11706>`_: Fixed reporting of teardown errors in higher-scoped fixtures when using `--maxfail` or `--stepwise`.

Originally added in pytest 8.0.0, but reverted in 8.0.2 due to a regression in pytest-xdist.
This regression was fixed in pytest-xdist 3.6.1.


- `11797 <https://github.com/pytest-dev/pytest/issues/11797>`_: :func:`pytest.approx` now correctly handles :class:`Sequence <collections.abc.Sequence>`-like objects.


- `12204 <https://github.com/pytest-dev/pytest/issues/12204>`_, `#12264 <https://github.com/pytest-dev/pytest/issues/12264>`_: Fixed a regression in pytest 8.0 where tracebacks get longer and longer when multiple
tests fail due to a shared higher-scope fixture which raised -- by :user:`bluetech`.

Also fixed a similar regression in pytest 5.4 for collectors which raise during setup.

The fix necessitated internal changes which may affect some plugins:

* ``FixtureDef.cached_result[2]`` is now a tuple ``(exc, tb)``
 instead of ``exc``.
* ``SetupState.stack`` failures are now a tuple ``(exc, tb)``
 instead of ``exc``.


- `12275 <https://github.com/pytest-dev/pytest/issues/12275>`_: Fixed collection error upon encountering an :mod:`abstract <abc>` class, including abstract `unittest.TestCase` subclasses.


- `12328 <https://github.com/pytest-dev/pytest/issues/12328>`_: Fixed a regression in pytest 8.0.0 where package-scoped parameterized items were not correctly reordered to minimize setups/teardowns in some cases.


- `12424 <https://github.com/pytest-dev/pytest/issues/12424>`_: Fixed crash with `assert testcase is not None` assertion failure when re-running unittest tests using plugins like pytest-rerunfailures. Regressed in 8.2.2.


- `12472 <https://github.com/pytest-dev/pytest/issues/12472>`_: Fixed a crash when returning category ``"error"`` or ``"failed"`` with a custom test status from :hook:`pytest_report_teststatus` hook -- :user:`pbrezina`.


- `12505 <https://github.com/pytest-dev/pytest/issues/12505>`_: Improved handling of invalid regex patterns in :func:`pytest.raises(match=r'...') <pytest.raises>` by providing a clear error message.


- `12580 <https://github.com/pytest-dev/pytest/issues/12580>`_: Fixed a crash when using the cache class on Windows and the cache directory was created concurrently.


- `6962 <https://github.com/pytest-dev/pytest/issues/6962>`_: Parametrization parameters are now compared using `==` instead of `is` (`is` is still used as a fallback if the parameter does not support `==`).
This fixes use of parameters such as lists, which have a different `id` but compare equal, causing fixtures to be re-computed instead of being cached.


- `7166 <https://github.com/pytest-dev/pytest/issues/7166>`_: Fixed progress percentages (the ``[ 87%]`` at the edge of the screen) sometimes not aligning correctly when running with pytest-xdist ``-n``.



Improved documentation
----------------------

- `12153 <https://github.com/pytest-dev/pytest/issues/12153>`_: Documented using :envvar:`PYTEST_VERSION` to detect if code is running from within a pytest run.


- `12469 <https://github.com/pytest-dev/pytest/issues/12469>`_: The external plugin mentions in the documentation now avoid mentioning
:std:doc:`setuptools entry-points <setuptools:index>` as the concept is
much more generic nowadays. Instead, the terminology of "external",
"installed", or "third-party" plugins (or packages) replaces that.

-- by :user:`webknjaz`


- `12577 <https://github.com/pytest-dev/pytest/issues/12577>`_: `CI` and `BUILD_NUMBER` environment variables role is discribed in
the reference doc. They now also appear when doing `pytest -h`
-- by :user:`MarcBresson`.



Contributor-facing changes
--------------------------

- `12467 <https://github.com/pytest-dev/pytest/issues/12467>`_: Migrated all internal type-annotations to the python3.10+ style by using the `annotations` future import.

-- by :user:`RonnyPfannschmidt`


- `11771 <https://github.com/pytest-dev/pytest/issues/11771>`_, `#12557 <https://github.com/pytest-dev/pytest/issues/12557>`_: The PyPy runtime version has been updated to 3.9 from 3.8 that introduced
a flaky bug at the garbage collector which was not expected to fix there
as the 3.8 is EoL.

-- by :user:`x612skm`


- `12493 <https://github.com/pytest-dev/pytest/issues/12493>`_: The change log draft preview integration has been refactored to use a
third party extension ``sphinxcontib-towncrier``. The previous in-repo
script was putting the change log preview file at
:file:`doc/en/_changelog_towncrier_draft.rst`. Said file is no longer
ignored in Git and might show up among untracked files in the
development environments of the contributors. To address that, the
contributors can run the following command that will clean it up:

.. code-block:: console

  $ git clean -x -i -- doc/en/_changelog_towncrier_draft.rst

-- by :user:`webknjaz`


- `12498 <https://github.com/pytest-dev/pytest/issues/12498>`_: All the undocumented ``tox`` environments now have descriptions.
They can be listed in one's development environment by invoking
``tox -av`` in a terminal.

-- by :user:`webknjaz`


- `12501 <https://github.com/pytest-dev/pytest/issues/12501>`_: The changelog configuration has been updated to introduce more accurate
audience-tailored categories. Previously, there was a ``trivial``
change log fragment type with an unclear and broad meaning. It was
removed and we now have ``contrib``, ``misc`` and ``packaging`` in
place of it.

The new change note types target the readers who are downstream
packagers and project contributors. Additionally, the miscellaneous
section is kept for unspecified updates that do not fit anywhere else.

-- by :user:`webknjaz`


- `12502 <https://github.com/pytest-dev/pytest/issues/12502>`_: The UX of the GitHub automation making pull requests to update the
plugin list has been updated. Previously, the maintainers had to close
the automatically created pull requests and re-open them to trigger the
CI runs. From now on, they only need to click the `Ready for review`
button instead.

-- by :user:`webknjaz`


- `12522 <https://github.com/pytest-dev/pytest/issues/12522>`_: The ``:pull:`` RST role has been replaced with a shorter
``:pr:`` due to starting to use the implementation from
the third-party :pypi:`sphinx-issues` Sphinx extension
-- by :user:`webknjaz`.


- `12531 <https://github.com/pytest-dev/pytest/issues/12531>`_: The coverage reporting configuration has been updated to exclude
pytest's own tests marked as expected to fail from the coverage
report. This has an effect of reducing the influence of flaky
tests on the resulting number.

-- by :user:`webknjaz`


- `12533 <https://github.com/pytest-dev/pytest/issues/12533>`_: The ``extlinks`` Sphinx extension is no longer enabled. The ``:bpo:``
role it used to declare has been removed with that. BPO itself has
migrated to GitHub some years ago and it is possible to link the
respective issues by using their GitHub issue numbers and the
``:issue:`` role that the ``sphinx-issues`` extension implements.

-- by :user:`webknjaz`


- `12562 <https://github.com/pytest-dev/pytest/issues/12562>`_: Possible typos in using the ``:user:`` RST role is now being linted
through the pre-commit tool integration -- by :user:`webknjaz`.

8.2.2

=========================

Bug Fixes
---------

- `12355 <https://github.com/pytest-dev/pytest/issues/12355>`_: Fix possible catastrophic performance slowdown on a certain parametrization pattern involving many higher-scoped parameters.


- `12367 <https://github.com/pytest-dev/pytest/issues/12367>`_: Fix a regression in pytest 8.2.0 where unittest class instances (a fresh one is created for each test) were not released promptly on test teardown but only on session teardown.


- `12381 <https://github.com/pytest-dev/pytest/issues/12381>`_: Fix possible "Directory not empty" crashes arising from concurent cache dir (``.pytest_cache``) creation. Regressed in pytest 8.2.0.



Improved Documentation
----------------------

- `12290 <https://github.com/pytest-dev/pytest/issues/12290>`_: Updated Sphinx theme to use Furo instead of Flask, enabling Dark mode theme.


- `12356 <https://github.com/pytest-dev/pytest/issues/12356>`_: Added a subsection to the documentation for debugging flaky tests to mention
lack of thread safety in pytest as a possible source of flakyness.


- `12363 <https://github.com/pytest-dev/pytest/issues/12363>`_: The documentation webpages now links to a canonical version to reduce outdated documentation in search engine results.
Links

Update fiftyone from 0.23.8 to 0.25.0.

Changelog

0.24.1

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-0-24-1) for details.

0.24.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-0-24-0) for details.
Links

Update datasets from 2.19.1 to 2.21.0.

The bot wasn't able to find a changelog for this release. Got an idea?

Links

Update ultralytics from 8.2.48 to 8.2.86.

Changelog

8.2.86

🌟 Summary
The v8.2.86 release focuses on improving model export functionality, expanding operating system compatibility, and refining code quality across the Ultralytics project. 

📊 Key Changes
- 🛠️ **Model Export Enhancements**: Updated logging for export failures, streamlined export logic, and improved error handling.
- 💻 **Windows Compatibility**: Added comprehensive testing for Windows and adjusted dependencies to address issues with PyTorch.
- 🎨 **Code Modernization**: Implemented modern Python practices like f-strings and argument-less `super()`.
- 🔢 **Improved Dataset Handling**: Refined calibration and data loading processes to ensure consistency and reliability.

🎯 Purpose & Impact
- **Enhanced Export Reliability**: By increasing log visibility and removing unnecessary checks, users can diagnose issues faster, ensuring smoother model deployments.
- **Widened OS Support**: Including Windows in the CI testing matrix broadens the platform support, making the tool more versatile for developers on different systems.
- **Cleaner Codebase**: Modernized code not only boosts maintainability but also provides minor performance gains, making the project easier for new contributors to navigate.
- **Consistency in Model Performance**: Adjusting data loaders and calibration methods enhances the accuracy and repeatability of experiments and deployments. 

These changes collectively aim to improve user experience, increase software reliability, and enhance performance stability. 🚀

What's Changed
* PyUpgrade 3.8 updates by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15941
* Fixed OpenVINO int8 dynamic export and other minor changes by ambitious-octopus in https://github.com/ultralytics/ultralytics/pull/14872
* `ultralytics 8.2.86` Windows `torch==2.4.0` patch by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15942


**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.85...v8.2.86

8.2.85

🌟 Summary
The `v8.2.85` release for Ultralytics YOLO highlights the latest updates, focusing on the upcoming YOLOv10 enhancements, streamlined workflows, and improved compatibility across the platform.

📊 Key Changes
- **YOLOv10 Parameter Fix**: Introduced a `max_det` parameter, enhancing user control by allowing the specification of the maximum number of detections. This update is a pivotal improvement leading up to YOLOv10, aligning with ongoing efforts to optimize model configurability and performance.
- **GitHub Actions Update**: Streamlined the publish workflow by removing the `openai` dependency and consolidating complex scripts into a single, efficient command. This significantly simplifies the release process.
- **INT8 Export Warning**: Added a warning for automatic enforcement of `dynamic=True` during INT8 model exports to enhance compatibility, ensuring smoother user experiences with advanced export settings.
- **Documentation Enhancements**: Improved author attribution with avatars in documentation, optimizing related tools and making contributions more visible and accessible to users.
- **Explorer Tests Requirement**: Updated tests to require PyTorch version 1.13 or newer, ensuring compatibility, reliability, and stability across development environments.

🎯 Purpose & Impact
- **YOLOv10 Readiness**: The new `max_det` parameter is a key enhancement that sets the stage for YOLOv10, giving users greater control and customization options over model outputs.
- **Optimized Release Workflow**: The streamlined workflow reduces complexity and potential dependency issues, facilitating faster and more efficient publishing of updates.
- **Enhanced Export Compatibility**: The INT8 export warning for `dynamic=True` ensures compliance with optimal settings, improving export reliability and performance.
- **Improved Documentation**: Enhanced visualization with author avatars increases transparency and improves user interaction with the documentation.
- **Reliable Testing**: By enforcing minimum version requirements for PyTorch, the update guarantees stable and consistent testing, enhancing overall development reliability.

These updates emphasize Ultralytics' commitment to enhancing YOLOv10's functionality, improving user control, and refining the overall development and deployment experience.

What's Changed
* Optimize docs author avatars by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15923
* Explorer tests require torch>=1.13 by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15930
* Update notebooks: Fix `classes_names` argument with `names` by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15915
* Includes warning for enforced `dynamic` during INT8 exports by Burhan-Q in https://github.com/ultralytics/ultralytics/pull/15874
* Update publish.yml by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15932
* Update publish.yml by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15933
* `ultralytics 8.2.85` YOLOv10 `max_det` arg fix by ambitious-octopus in https://github.com/ultralytics/ultralytics/pull/15917


**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.84...v8.2.85

8.2.84

🌟 Summary
This update introduces flexible image size inference for SAM2 using the `ultralytics` package, alongside improvements to testing and documentation.

📊 Key Changes
- **Flexible SAM2 Image Size Inference:** SAM2 now supports custom image sizes through the `ultralytics` package, allowing inference at sizes like 640x640 instead of the default 1024x1024.
- **Testing Enhancement:** Updated CI testing workflow for version-specific compatibility.
- **Documentation Update:** Refreshed documentation with higher quality images.

🎯 Purpose & Impact
- **Enhanced Flexibility:** Users can now run SAM2 inference using the `ultralytics` package with custom `imgsz` values (e.g., `imgsz=640`), offering significant advantages:
- Faster processing times for smaller images
- Reduced memory usage, enabling inference on devices with limited resources
- Maintains good segmentation quality while allowing size-performance tradeoffs
- **Improved Efficiency:** The ability to use smaller image sizes (like 640x640) instead of the default 1024x1024 can lead to faster inference without significant loss in accuracy for many use cases.
- **Broader Accessibility:** This update makes SAM2 more accessible for users with varying computational resources, as they can now adjust the image size based on their specific needs and hardware constraints.

💻 Usage Example
python
from ultralytics import SAM

Initialize SAM model
model = SAM('sam2_b.pt')

Run inference with custom image size
results = model('path/to/image.jpg', imgsz=640)


This update significantly enhances SAM2's versatility within the `ultralytics` ecosystem, allowing users to fine-tune the balance between speed and accuracy based on their specific requirements.

What's Changed
* Add retry step to failed Conda tests by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15884
* Use AVIF banner images by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15876
* Remove image "?" args by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15891
* fix HUB download and train by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15896
* Optimize Docs images by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15900
* Run Conda tests with aligned tag/version by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15904
* Adding missing datasets information to docs by jk4e in https://github.com/ultralytics/ultralytics/pull/15916
* `ultralytics 8.2.84` new SAM flexible `imgsz` inference by Laughing-q in https://github.com/ultralytics/ultralytics/pull/15882


**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.83...v8.2.84

8.2.83

🌟 Summary
The v8.2.83 release of Ultralytics introduces improved disk cleanup processes, enhances community engagement options, and makes changes to work with GitHub Actions and documentation.

📊 Key Changes
- **Issue Template Enhancements**: Added Reddit as a new contact link, providing an additional platform for community interaction.
- **Docker Workflow Update**: Improved disk cleanup using a new method to free up to 30GB of space, making builds more efficient.
- **Documentation & Guidance Tweaks**: Updated messages and documentation references to streamline contributions and improve user experience.
- **GitHub Actions Improvements**: Enhanced branch management automation by labeling popular pull requests and clarifying process outputs.
- **VS Code Integration**: Introduced a new VS Code extension with code snippets to accelerate development workflows with Ultralytics. 

🎯 Purpose & Impact
- **Community Engagement**: Adding Reddit as a contact method broadens the engagement avenues, fostering a richer community interaction.
- **Efficiency in CI/CD**: The new disk cleanup approach significantly reduces disk usage during CI/CD, accelerating build and release processes.
- **Enhanced User Experience**: Refined documentation and automated pull request updates ensure smoother user and contributor interactions.
- **Developer Productivity**: The VS Code extension aids developers by providing quick access to code snippets, reducing development time and potential errors.

What's Changed
* Update merge-main-into-prs.yml by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15801
* Fix very large banner SVGs bug by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15803
* Rate limit auto-merge action by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15802
* Auto-label PR if above threshold for positive reactions by Burhan-Q in https://github.com/ultralytics/ultralytics/pull/13605
* Add Reddit link to documentation and templates by Y-T-G in https://github.com/ultralytics/ultralytics/pull/15041
* Add https://www.reddit.com/r/Ultralytics/ badge by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15818
* Add VS Code Extension by Burhan-Q in https://github.com/ultralytics/ultralytics/pull/15027
* Cleanup GitHub Runner for Docker CI by lakshanthad in https://github.com/ultralytics/ultralytics/pull/15848
* Fix typo in docstring in `metrics.py` by jk4e in https://github.com/ultralytics/ultralytics/pull/15842
* Add warning message on `distance-calculation.md` docs page by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15838
* Fix link in README.zh-CN.md by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15858
* Fix loaders.py broken YouTube example URLs by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15863
* Improve Docs layout issues by jk4e in https://github.com/ultralytics/ultralytics/pull/15868
* Add https://youtu.be/WwXnljc7ZUM to docs by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15870
* `ultralytics 8.2.83` fix SAM2 CLI usage by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15871


**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.82...v8.2.83

8.2.82

🌟 Summary
The Ultralytics v8.2.82 release introduces significant advancements with the addition of **YOLOv10 export support** for CoreML, Edge TPU, and TF.js, marking this as the standout feature of the update.

📊 Key Changes
- **YOLOv10 Export Support**: Expanded export capabilities now include CoreML, Edge TPU, and TF.js, enabling broader deployment options for YOLOv10 models across different platforms and devices.
- **Docstring Style Adjustments**: Updates to the documentation build workflow to ignore specific style rules for docstrings to align with Google-style conventions.
- **Automated Code Style Checks**: Integration of `ruff` as a new tool to perform style checks and fixes across the codebase, with a particular focus on improving docstring consistency.
- **Examples & Code Cleanup**: Improvements and refinements in example scripts and code snippets, enhancing clarity and consistency, particularly in docstring formats and argument examples.
- **Multilingual Documentation**: Minor updates to documentation links and the addition of new language support for specific parts of the guides.

🎯 Purpose & Impact
- **Enhanced Deployment Options**: The new export capabilities for YOLOv10 models significantly broaden the range of deployment scenarios, making it easier for developers to deploy models on various platforms, including Apple devices, Google's Edge TPU, and web environments via TF.js.
- **Improved Developer Experience**: Consistent and clear docstring styles improve code readability and maintainability, helping developers understand and contribute more efficiently.
- **User-Friendly Examples**: More accurate and consistent example scripts enable users to replicate and learn from them more effectively, reducing errors during implementation.
- **Global Accessibility**: The expansion of multilingual documentation allows a wider global audience to access resources in their preferred languages, enhancing usability and outreach.

What's Changed
* Update robots.txt by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15789
* Properly use cmake variable in ONNXRuntime by memorylorry in https://github.com/ultralytics/ultralytics/pull/15776
* Missing best.pt resumed checkpoint upload spelling by sergiuwaxmann in https://github.com/ultralytics/ultralytics/pull/15772
* 'best.pt' inherit all-epochs results curves from 'last.pt' by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15791
* Ruff format docstring Python code by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15792
* Ruff Docstring formatting by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15793
* TQDM, SimpleClass, IterableSimpleNamespace docstrings by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15795
* Fix YOLOv8 C++ ONNXRuntime transpose op by memorylorry in https://github.com/ultralytics/ultralytics/pull/15779
* `ultralytics 8.2.82` YOLOv10 CoreML, Edge TPU, and TF.js export support by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15796

New Contributors
* memorylorry made their first contribution in https://github.com/ultralytics/ultralytics/pull/15776

**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.81...v8.2.82

8.2.81

🌟 Summary
The v8.2.81 release of Ultralytics YOLO introduces significant documentation improvements and a refined model upload process to enhance usability and reliability for machine learning practitioners.

📊 Key Changes
- **Documentation Enhancements**: Updated how code examples and citations are presented across various dataset guides to improve readability and user accessibility.
- **Model Upload Process**: Improved handling of model uploads with added safeguards and informative logging, particularly in transient environments like Google Colab.
- **Technical Adjustment**: Corrected bounding box conversion details in the results module, changing from top-left coordinates to center-point coordinates.

🎯 Purpose & Impact
- **Easier Understanding and Use**: The new documentation format with examples in both Python and CLI makes it more straightforward for users to implement various datasets in their projects.
- **Robust Model Management**: Enhanced model upload functionality ensures continuity and mitigates issues in cloud-based environments, promoting more reliable training sessions.
- **Accurate Representation**: The bounding box conversion adjustment aligns technical descriptions with actual functionalities, ensuring users correctly apply transformations.

What's Changed
* Add https://youtu.be/WwXnljc7ZUM to docs by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15751
* Improve Docs dataset layout issues by jk4e in https://github.com/ultralytics/ultralytics/pull/15696
* Fix `xywh` docstring by Laughing-q in https://github.com/ultralytics/ultralytics/pull/15765
* Ensure matplotlib backend gets reset with plt_settings by rschroll in https://github.com/ultralytics/ultralytics/pull/15759
* `ultralytics 8.2.81` fix HUB missing 'best.pt' resumed checkpoint upload by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15754

New Contributors
* rschroll made their first contribution in https://github.com/ultralytics/ultralytics/pull/15759

**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.80...v8.2.81

8.2.80

🌟 Summary

The v8.2.80 release of the Ultralytics YOLO software brings a mix of behind-the-scenes improvements, documentation updates, and usability enhancements, particularly around data handling and workflow automation. 📦

📊 Key Changes

- **GitHub Workflows Adjustment**: Modifications made to GitHub Actions workflows to streamline pull request and publication processes by refining the way PR details are extracted.
- **Enhanced Dataset Management**: Added a new section in documentation about downloading datasets directly from Ultralytics HUB.
- **Documentation Language Links Update**: Some corrections and improvements in language link references in both the main README and tutorials.
- **Model Interface Improvement**: Expanded support for input types, including PIL (Python Imaging Library) images, for more versatile image processing.
- **Metrics Code Update**: Tweaked how class names are handled in plotting functions, shifting from list to dictionary format for better identification and flexibility.

🎯 Purpose & Impact

- **Streamlined Processes**: The workflow updates aim to improve developer efficiency and reduce errors in managing code changes, enhancing the overall continuous integration experience. 🚀
- **User-Friendly Dataset Access**: The added documentation helps users easily download datasets, making data preparation more straightforward and less time-consuming. 📚
- **Better Compatibility**: By accepting PIL images, the model becomes more versatile, especially beneficial for users integrating with various image processing libraries. 🖼️
- **Improved Accuracy**: Using dictionaries for class names in metrics promotes better clarity and precision in data interpretation and result visualization, aiding in more insightful analysis. 📈

What's Changed
* Remove Hindi and Dutch languages by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15703
* Remove Hindi and Dutch languages by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15704
* Update publish.yml to use `gh` by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15686
* Update HUB Docs for new dataset download feature by sergiuwaxmann in https://github.com/ultralytics/ultralytics/pull/15728
* Fix model `names` docstring type to `dict` by yuefanhao in https://github.com/ultralytics/ultralytics/pull/15726
* `ultralytics 8.2.80` add PIL type hints to `model()`  by JoshJarabek7 in https://github.com/ultralytics/ultralytics/pull/15719

New Contributors
* yuefanhao made their first contribution in https://github.com/ultralytics/ultralytics/pull/15726
* JoshJarabek7 made their first contribution in https://github.com/ultralytics/ultralytics/pull/15719

**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.79...v8.2.80

8.2.79

🌟 Summary
The v8.2.79 update for Ultralytics YOLO brings improvements in documentation workflows, a refined deployment process, and better compatibility for inference tasks.

📊 Key Changes
- **Documentation Workflow Overhaul**: The documentation workflow (`docs.yml`) has been established as a separate process to streamline the documentation updates for user clarity.
- **Publishing Process Updates**: Adjustments to the publishing workflow ensure cleaner and more efficient version checking and deployment, focusing now solely on PyPI without doc deployments.
- **Inference Resolution Change**: The inference example now uses a resolution of 640x640 instead of 640x480 for improved detection precision.
- **Enhanced Compatibility**: Updates in the model's post-processing provide better compatibility with Apple's MPS and CoreML.

🎯 Purpose & Impact
- **Documentation Clarity and Efficiency**: Separating doc updates into a dedicated workflow allows for more organized and error-free documentation updates, ensuring users have access to the latest insights and instructions.
- **Streamlined Release Management**: Fine-tuning the release process focuses the development efforts on core functionalities and ensures versions are correctly managed and published.
- **Improved Detection Performance**: The updated resolution in inference examples enhances detection accuracy, making the solution better suited for high-resolution object detection tasks.
- **Broadened Compatibility**: The changes ensure that Ultralytics software runs smoothly on macOS, expanding the capability across different hardware setups and enhancing user experience.

These enhancements strive to make Ultralytics' tools more robust, user-friendly, and functionally versatile for all users, from developers to dataset trainers. 🚀

What's Changed
* Split Docs action into separate workflow by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15656
* Add https://youtu.be/28JV4rbzklM to docs by RizwanMunawar in https://github.com/ultralytics/ultralytics/pull/15663
* Fix YOLOv8 C++ Example model input size by AD-lite24 in https://github.com/ultralytics/ultralytics/pull/15665
* Skip Docs push if no changes by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15675
* Simplify publish action by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15657
* Bump contributor-assistant/github-action from 2.4.0 to 2.5.1 in /.github/workflows by dependabot in https://github.com/ultralytics/ultralytics/pull/15681
* `ultralytics 8.2.79` YOLOv10 CoreML and MPS training "gather" op error fix by Oil3 in https://github.com/ultralytics/ultralytics/pull/15672

New Contributors
* AD-lite24 made their first contribution in https://github.com/ultralytics/ultralytics/pull/15665
* Oil3 made their first contribution in https://github.com/ultralytics/ultralytics/pull/15672

**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.78...v8.2.79

8.2.78

🌟 Summary
Ultralytics 8.2.78 introduces several improvements to the code formatting process, updates links, and makes minor bug fixes to further enhance the project.

📊 Key Changes
- **GitHub Actions Update:** Modify the formatting workflow to handle additional file types and include a 'review_requested' trigger.
- **README and Documentation Updates:** Update URLs for YOLO Vision events across multiple README files and documentation.
- **Code Refactor:** Improved naming consistency and added docstrings in example scripts.
- **Notebook Enhancements:** Update introductory text and examples in several notebooks.

🎯 Purpose & Impact
- **Enhanced Code Formatting:** The updated workflow now formats YAML, JSON, Markdown, and CSS files and includes a new trigger for 'review_requested' events, ensuring comprehensive code quality.
- *Impact:* Streamlined contributions with consistent formatting across various file types.
- **Updated Links:** Pointing to the latest events and resources ensures that users access the most current information.
- *Impact:* Easier navigation to relevant events and resources.
- **Refactored Examples and Notebooks:** Improved clarity and functionality, including better documentation and consistent naming.
- *Impact:* Easier for users to understand and follow example scripts, enhancing the learning experience.

By integrating these updates, Ultralytics takes a step towards more refined and user-friendly development practices. 🛠️📈

8.2.77

🌟 Summary
Ultralytics' v8.2.77 introduces a variety of enhancements, including technical infrastructure improvements and updated documentation for improved user and developer experience.

📊 Key Changes
- **Cleanup Tool Cache**: Added a step to free up space on the GitHub Actions runner.
- **Removal of `.pre-commit-config.yaml`**: Deleted the configuration file used for pre-commit hooks.
- **Documentation Updates**: Improved contributing guide to provide clearer instructions and visuals.
- **New Parameter in YOLOv8 Plot Function**: Added `color_mode` parameter to `plot` method.
- **Inference Modifications**: Modified device check conditions in DDP training.

🎯 Purpose & Impact
- **Enhanced CI/CD Efficiency**: The cleanup step aims to free up disk space before installing packages, potentially preventing failures due to lack of space.
- **Streamlined Codebase**: Removing the `.pre-commit-config.yaml` simplifies the repository by eliminating unnecessary configuration, making it lighter and easier to manage.
- **Contributor Friendliness**: Improved documentation provides a more welcoming and guiding environment for new contributors, encouraging community engagement.
- **Visualization Flexibility**: The addition of `color_mode` to the `plot` method allows for instance-based or class-based color settings, providing more customization options in visual outputs.
- **Training and Inference Optimization**: Adjustments to device handling enable more robust handling of non-GPU environments, such as CPU or MPS.

These updates collectively enhance both the developer and user experience, making the project more efficient, accessible, and customizable. 🚀

What's Changed
* Update Contributing guidelines by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15373
* Fixed multiscale preprocess_batch by ambitious-octopus in https://github.com/ultralytics/ultralytics/pull/15392
* Improve trainer DDP device handling by alanZee in https://github.com/ultralytics/ultralytics/pull/15383
* Update Conda CI by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15443
* Update Tracker docstrings by glenn-jocher in https://github.com/ultralytics/ultralytics/pull/15469
* `ultralytics 8.2.77` new `color_mode=instance` plot arg by Laughing-q in https://github.com/ultralytics/ultralytics/pull/15034

New Contributors
* alanZee made their first contribution in https://github.com/ultralytics/ultralytics/pull/15383

**Full Changelog**: https://github.com/ultralytics/ultralytics/compare/v8.2.76...v8.2.77

8.2.76

🌟 Summary
Ultralytics 'v8.2.76' release includes updates focused on improving documentation, adding new plugins, and enhancing code functionality.

📊 Key Changes
- **Documentation Updates**: 
- Introduced `mkdocs-macros-plugin` for better content duplication across docs.
- Added video support in documentation for enhanced visualization.
- Corrected bibliography formatting and references.
- **Code Enhancements**: 
- Improved error handling and handling of large inputs in the SAHI integration example.
- Added a workaround for YouTube test skips in GitHub Actions to avoid unauthorized errors.
- Adjusted `convert_segment_masks_to_yolo_seg` function for better user guidance.
- **Dependencies**: 
- Includ

@dagshub
Copy link

dagshub bot commented Sep 2, 2024

@pyup-bot
Copy link
Contributor Author

pyup-bot commented Sep 9, 2024

Closing this in favor of #527

@pyup-bot pyup-bot closed this Sep 9, 2024
@guysmoilov guysmoilov deleted the pyup-scheduled-update-2024-09-02 branch September 9, 2024 14:53
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