joblib

Домашняя страница joblib с пользовательской документацией находится по адресу:

https://joblib.readthedocs.io

Получение последней версии кода

Чтобы получить последнюю версию кода с помощью git, просто введите:

 git-клон https://github.com/joblib/joblib.git

Если у вас не установлен git, вы можете загрузить zip-архив последней версии кода: https://github.com/joblib/joblib/archive/refs/heads/main.zip.

Установка

Вы можете использовать pip для установки joblib:

 pip установить joblib

из любого каталога или:

 установка python setup.py

из исходного каталога.

Зависимости

• Joblib не имеет обязательных зависимостей, кроме Python (поддерживаемые версии: 3.8+).
• Joblib имеет дополнительную зависимость от Numpy (по крайней мере версии 1.6.1) для манипуляций с массивами.
• Joblib включает собственную копию loky для управления процессами.
• Joblib может эффективно выгружать и загружать массивы numpy, но не требует установки numpy.
• Joblib имеет дополнительную зависимость от python-lz4 как более быстрой альтернативы zlib и gzip для сжатой сериализации.
• Joblib имеет дополнительную зависимость от psutil для уменьшения утечек памяти в параллельных рабочих процессах.
• Некоторые примеры требуют внешних зависимостей, таких как pandas. Подробности смотрите в инструкциях в разделе «Создание документации».

Рабочий процесс для внесения вклада

Чтобы внести свой вклад в joblib, сначала создайте учетную запись на github. Как только это будет сделано, создайте из репозитория joblib собственный репозиторий и клонируйте его с помощью git clone на компьютерах, на которых вы хотите работать. Внесите изменения в свой клон, отправьте их в свою учетную запись github, протестируйте на нескольких компьютерах и, когда они вас устроят, отправьте запрос на включение в основной репозиторий.

Запуск набора тестов

Для запуска набора тестов вам понадобятся модули pytest (версия >= 3) и покрытия. Запустите набор тестов, используя:

 pytest joblib

из корня проекта.

Создание документации

Для сборки документации вам необходимо установить sphinx (>=1.4) и некоторые зависимости:

 pip install -U -r .readthedocs-requirements.txt

Затем документы можно создать с помощью следующей команды:

 сделать документ

Документы HTML расположены в каталоге doc/_build/html .

Создание исходного архива

Чтобы создать архив с исходным кодом, например, для упаковки или распространения, выполните следующую команду:

 python setup.py сдист

Архив будет создан в каталоге dist. Эта команда скомпилирует документы, и полученный архив можно будет установить без каких-либо дополнительных зависимостей, кроме стандартной библиотеки Python. Вам понадобится setuptool и sphinx.

Делаем релиз и заливаем его в PyPI

Эту команду запускает только менеджер проекта для выпуска выпуска и загрузки в PyPI:

 python setup.py sdist bdist_wheel
расстояние загрузки шпагата/*

Обратите внимание, что документация должна автоматически обновляться при каждом нажатии git. Если это не так, попробуйте создать документ локально и устраните любую ошибку сборки документа (особенно при запуске примеров).

Обновление журнала изменений

Изменения перечислены в файле CHANGES.rst. Их необходимо обновить вручную, но для генерации строк можно использовать следующую команду git:

 git log --abbrev-commit --date=short --no-merges --sparse