Skip to content

Commit

Permalink
Deploying to gh-pages from @ a009d55 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
svirpioj committed Oct 11, 2023
1 parent 7c3898b commit d28d852
Show file tree
Hide file tree
Showing 42 changed files with 193 additions and 180 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7480e756a8bea7642bb1a7d2be2c6af5
config: 823ce38d1a2dbf828e3c20483148c879
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/CHANGELOG.doctree
Binary file not shown.
Binary file modified .doctrees/CONTRIBUTING.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/installation.doctree
Binary file not shown.
216 changes: 112 additions & 104 deletions CHANGELOG.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions CONTRIBUTING.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Contributing &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
Expand Down Expand Up @@ -119,7 +119,7 @@ <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to t
few rules for pull requests:</p>
<ul class="simple">
<li><p>Make a pull request to the <code class="docutils literal notranslate"><span class="pre">develop</span></code> branch instead of <code class="docutils literal notranslate"><span class="pre">master</span></code>.</p></li>
<li><p>The code should support at least Python versions from 3.7 to 3.10.</p></li>
<li><p>The code should support at least Python versions from 3.7 to 3.11.</p></li>
<li><p>Please follow <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP 8</a>. Exception: The maximum line length is 127 characters instead of 79.</p></li>
<li><p>Especially for new features, please include test cases for unit testing.</p></li>
</ul>
Expand All @@ -131,8 +131,8 @@ <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to t
work, if you have VariKN and eflomal set up as instructed - <code class="docutils literal notranslate"><span class="pre">pytest</span></code>
skips the respective tests if not.)</p>
<p>GitHub workflows defined in the project run automatically <code class="docutils literal notranslate"><span class="pre">flake8</span></code>
checks and unit testing with <code class="docutils literal notranslate"><span class="pre">pytest</span></code> using Python 3.7, 3.8, 3.9, and
3.10.</p>
checks and unit testing with <code class="docutils literal notranslate"><span class="pre">pytest</span></code> using Python 3.7, 3.8, 3.9,
3.10, and 3.11.</p>
<p>Especially for larger contributions, consider using a code analysis
tool like <a class="reference external" href="https://github.com/PyCQA/pylint">Pylint</a>. Install it
e.g. via <code class="docutils literal notranslate"><span class="pre">pip</span></code>, run <code class="docutils literal notranslate"><span class="pre">pylint</span> <span class="pre">opusfilter/</span></code> in the project root and fix
Expand Down
15 changes: 10 additions & 5 deletions _sources/CHANGELOG.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [3.0.0rc1] - 2023-09-20
## [3.0.0] - 2023-10-11

### Added

Expand All @@ -16,12 +16,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- refactor code and move auxiliary methods to opusfilter.util
- update varikn installation instructions (installable from PyPI)
- update github workflows
- update github workflows and include Python 3.11 tests
- update library version requirements to support Python 3.11
- use xxhash instead of pyhash for hash functions
- use opus-fast-mosestokenizer instead of fast-mosestokenizer
- install eflomal from PyPI and use the new interface in WordAlignFilter
- remove Python 3.6 support and tests

### Removed

- Python 3.6 support

### Fixed

Expand Down Expand Up @@ -184,8 +189,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
First tagged version.


[Unreleased]: https://github.com/Helsinki-NLP/OpusFilter/compare/3.0.0rc1...develop
[3.0.0rc1]: https://github.com/Helsinki-NLP/OpusFilter/compare/2.6.0...3.0.0rc1
[Unreleased]: https://github.com/Helsinki-NLP/OpusFilter/compare/3.0.0...develop
[3.0.0]: https://github.com/Helsinki-NLP/OpusFilter/compare/2.6.0...3.0.0
[2.6.0]: https://github.com/Helsinki-NLP/OpusFilter/compare/2.5.1...2.6.0
[2.5.1]: https://github.com/Helsinki-NLP/OpusFilter/compare/2.5.0...2.5.1
[2.5.0]: https://github.com/Helsinki-NLP/OpusFilter/compare/2.4.0...2.5.0
Expand Down
6 changes: 3 additions & 3 deletions _sources/CONTRIBUTING.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ issues page. We are also happy to consider pull requests. There are a
few rules for pull requests:

* Make a pull request to the `develop` branch instead of `master`.
* The code should support at least Python versions from 3.7 to 3.10.
* The code should support at least Python versions from 3.7 to 3.11.
* Please follow [PEP 8](https://www.python.org/dev/peps/pep-0008/). Exception: The maximum line length is 127 characters instead of 79.
* Especially for new features, please include test cases for unit testing.

Expand All @@ -19,8 +19,8 @@ work, if you have VariKN and eflomal set up as instructed - `pytest`
skips the respective tests if not.)

GitHub workflows defined in the project run automatically `flake8`
checks and unit testing with `pytest` using Python 3.7, 3.8, 3.9, and
3.10.
checks and unit testing with `pytest` using Python 3.7, 3.8, 3.9,
3.10, and 3.11.

Especially for larger contributions, consider using a code analysis
tool like [Pylint](https://github.com/PyCQA/pylint). Install it
Expand Down
2 changes: 1 addition & 1 deletion _sources/installation.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Install from source:

Note that all required libraries are not available to install via PyPI
on Windows OS. On Linux and MacOS, it should work directly for Python
versions from 3.7 to 3.10.
versions from 3.7 to 3.11.

## Required libraries

Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '3.0.0rc2',
VERSION: '3.0.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions automatic_configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Automatic configuration generation &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Automatic configuration generation &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions command_line_tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Command line tools for analysis &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Command line tools for analysis &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/alignment_model_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Alignment model filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Alignment model filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/custom_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Custom filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Custom filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/language_model_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Language model filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Language model filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/length_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Length filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Length filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/script_and_language_identification_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Script and language identification filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Script and language identification filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/sentence_embedding_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Sentence embedding filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Sentence embedding filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions filters/special_character_and_similarity_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Special character and similarity filters &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Special character and similarity filters &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions functions/downloading_and_selecting_data.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Downloading and selecting data &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Downloading and selecting data &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions functions/filtering_and_scoring.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Filtering and scoring &mdash; OpusFilter 3.0.0rc2 documentation</title>
<title>Filtering and scoring &mdash; OpusFilter 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=a09b3cf9"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
Expand Down
Loading

0 comments on commit d28d852

Please sign in to comment.