Metadata-Version: 2.1
Name: seb
Version: 0.9.1
Summary: Scandinavian Embedding Benchmark
Author-email: Kenneth Enevoldsen <Kennethcenevoldsen@gmail.com>
License: MIT License
        
        Copyright © 2023 Kenneth Enevoldsen
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark
Project-URL: repository, https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark
Project-URL: documentation, https://KennethEnevoldsen.github.io/scandinavian-embedding-benchmark/
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mteb[beir] ==1.1.1
Requires-Dist: pydantic >=2.1.0
Requires-Dist: catalogue >=2.0.8
Requires-Dist: radicli >=0.0.25
Provides-Extra: cohere
Requires-Dist: cohere >=4.34 ; extra == 'cohere'
Provides-Extra: dev
Requires-Dist: cruft >=2.0.0 ; extra == 'dev'
Requires-Dist: pyright ==1.1.348 ; extra == 'dev'
Requires-Dist: ruff >=0.0.281 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-jupyter ==0.24.6 ; extra == 'docs'
Requires-Dist: mkdocs-material ==9.1.21 ; extra == 'docs'
Requires-Dist: mkdocstrings[python] ==0.22.0 ; extra == 'docs'
Requires-Dist: datawrapper >=0.5.3 ; extra == 'docs'
Requires-Dist: jupyter >=1.0.0 ; extra == 'docs'
Provides-Extra: fasttext
Requires-Dist: pybind11 >=2.11.0 ; extra == 'fasttext'
Requires-Dist: fasttext-wheel >=0.9.0 ; extra == 'fasttext'
Provides-Extra: mistral
Requires-Dist: transformers >=4.31.0 ; extra == 'mistral'
Provides-Extra: openai
Requires-Dist: openai >=0.27.4 ; extra == 'openai'
Provides-Extra: sonar
Requires-Dist: fairseq2 ; extra == 'sonar'
Requires-Dist: sonar-space >=0.1.0 ; extra == 'sonar'
Provides-Extra: tests
Requires-Dist: pytest >=7.1.3 ; extra == 'tests'
Requires-Dist: pytest-cov >=3.0.0 ; extra == 'tests'

<a href="https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark"><img src="https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/blob/main/docs/_static/logo.png?raw=true" width="120" align="right"/></a>

# Scandinavian Embedding Benchmark

[![PyPI](https://img.shields.io/pypi/v/seb.svg)][pypi status]
[![Python Version](https://img.shields.io/pypi/pyversions/seb)][pypi status]
[![documentation](https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/actions/workflows/documentation.yml/badge.svg)][documentation]
[![Tests](https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/actions/workflows/tests.yml/badge.svg)][tests]
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)]([ruff])
[![DOI](https://zenodo.org/badge/671737258.svg)](https://zenodo.org/doi/10.5281/zenodo.10078411)

[pypi status]: https://pypi.org/project/seb/
[documentation]: https://KennethEnevoldsen.github.io/scandinavian-embedding-benchmark/
[tests]: https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/actions?workflow=Tests
[ruff]: https://github.com/astral-sh/ruff


<!-- start short-description -->

A benchmark for evaluating sentence/document embeddings of Scandinavian language models.

<!-- end short-description -->

## Installation

You can install the Scandinavian Embedding Benchmark (`seb`) via [pip] from [PyPI]:

```bash
pip install seb
```

[pip]: https://pip.pypa.io/en/stable/installing/
[PyPI]: https://pypi.org/project/seb/


To see more examples, see the [documentation].

# 📖 Documentation

| Documentation         |                                                          |
| --------------------- | -------------------------------------------------------- |
| 🔧 **[Installation]**  | Installation instructions on how to install this package |
| 👩‍💻 **[Usage]**         | Introduction on how to use the package                   |
| 📖 **[Documentation]** | A minimal and developing documentation                   |


# 💬 Where to ask questions

| Type                           |                        |
| ------------------------------ | ---------------------- |
| 🚨 **Bug Reports**              | [GitHub Issue Tracker] |
| 🎁 **Feature Requests & Ideas** | [GitHub Issue Tracker] |
| 👩‍💻 **Usage Questions**          | [GitHub Discussions]   |
| 🗯 **General Discussion**       | [GitHub Discussions]   |

[Usage]: https://kennethenevoldsen.github.io/scandinavian-embedding-benchmark/getting_started/
[Documentation]: https://KennethEnevoldsen.github.io/scandinavian-embedding-benchmark/index.html
[Installation]: https://KennethEnevoldsen.github.io/scandinavian-embedding-benchmark/installation.html
[github issue tracker]: https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/issues
[github discussions]: https://github.com/KennethEnevoldsen/scandinavian-embedding-benchmark/discussions


