Skip to content

Commit

Permalink
Rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
juliuslipp committed Jul 16, 2024
1 parent 986ca70 commit d04e70a
Show file tree
Hide file tree
Showing 33 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/scripts/check_diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import sys
from typing import Dict

LIB_DIRS = ["libs/mixedbreadai"]
LIB_DIRS = ["libs/mixedbread-ai"]

if __name__ == "__main__":
files = sys.argv[1:]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
working-directory:
required: true
type: string
default: 'libs/mixedbreadai'
default: 'libs/mixedbread-ai'

env:
PYTHON_VERSION: "3.11"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/_scheduled_test.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Scheduled tests
run-name: langchain-mixedbreadai Scheduled tests
run-name: langchain-mixedbread-ai Scheduled tests

on:
workflow_dispatch:
Expand All @@ -20,7 +20,7 @@ jobs:
- "3.8"
- "3.11"
working-directory:
- "libs/mixedbreadai"
- "libs/mixedbread-ai"

steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# langchain-mixedbreadai
# langchain-mixedbread-ai

This repository contains the [Mixedbread AI](https://www.mixedbread.ai) Integration with Langchain.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions libs/mixedbreadai/Makefile → libs/mixedbread-ai/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ integration_test integration_tests:
PYTHON_FILES=.
MYPY_CACHE=.mypy_cache
lint format: PYTHON_FILES=.
lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/mixedbreadai --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
lint_package: PYTHON_FILES=langchain_mixedbreadai
lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/mixedbread-ai --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
lint_package: PYTHON_FILES=langchain_mixedbread_ai
lint_tests: PYTHON_FILES=tests
lint_tests: MYPY_CACHE=.mypy_cache_test

Expand All @@ -45,7 +45,7 @@ spell_check:
spell_fix:
poetry run codespell --toml pyproject.toml -w

check_imports: $(shell find langchain_mixedbreadai -name '*.py')
check_imports: $(shell find langchain_mixedbread_ai -name '*.py')
poetry run python ./scripts/check_imports.py $^

######################
Expand Down
10 changes: 5 additions & 5 deletions libs/mixedbreadai/README.md → libs/mixedbread-ai/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# langchain-mixedbreadai
# langchain-mixedbread-ai

This package contains the LangChain integration with MixedbreadAI
This package contains the LangChain integration with Mixedbread AI

## Installation

```bash
pip install -U langchain-mixedbreadai
pip install -U langchain-mixedbread-ai
```

And you should configure credentials by setting the following environment variables:
Expand All @@ -17,7 +17,7 @@ And you should configure credentials by setting the following environment variab
`MixedbreadAIEmbeddings` class exposes embeddings from MixedbreadAI.

```python
from langchain_mixedbreadai import MixedbreadAIEmbeddings
from langchain_mixedbread_ai import MixedbreadAIEmbeddings

embeddings = MixedbreadAIEmbeddings(mxbai_api_key="a legit baker id")
embeddings.embed_query("What is the meaning of life?")
Expand All @@ -28,7 +28,7 @@ embeddings.embed_query("What is the meaning of life?")
`MixedbreadAIRerank` class exposes reranker from MixedbreadAI.

```python
from langchain_mixedbreadai import MixedbreadAIRerank
from langchain_mixedbread_ai import MixedbreadAIRerank

reranker = MixedbreadAIRerank(mxbai_api_key="a legit baker id", top_n=3)
reranker.rerank(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"outputs": [],
"source": [
"# install package\n",
"%pip install -U langchain-mixedbreadai"
"%pip install -U langchain-mixedbread-ai"
]
},
{
Expand Down Expand Up @@ -60,7 +60,7 @@
},
"outputs": [],
"source": [
"from langchain_mixedbreadai.embeddings import EncodingFormat, MixedbreadAIEmbeddings\n",
"from langchain_mixedbread_ai.embeddings import EncodingFormat, MixedbreadAIEmbeddings\n",
"\n",
"your_api_key = \"you need a key to your oven\"\n",
"\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"outputs": [],
"source": [
"# install package\n",
"%pip install -U langchain-mixedbreadai"
"%pip install -U langchain-mixedbread-ai"
]
},
{
Expand Down Expand Up @@ -60,7 +60,7 @@
},
"outputs": [],
"source": [
"from langchain_mixedbreadai.rerank import MixedbreadAIRerank\n",
"from langchain_mixedbread_ai.rerank import MixedbreadAIRerank\n",
"\n",
"your_api_key = \"a key to oven\"\n",
"\n",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from importlib import metadata

from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings
from langchain_mixedbreadai.rerank import MixedbreadAIRerank
from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings
from langchain_mixedbread_ai.rerank import MixedbreadAIRerank

try:
__version__ = metadata.version(__package__)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
USER_AGENT = "@mixedbread-ai/langchain"


class MixedBreadAIClient(BaseModel):
class MixedbreadAIClient(BaseModel):
_client: MixedbreadAI = Field(default=None, exclude=True)
_aclient: AsyncMixedbreadAI = Field(default=None, exclude=True)
_request_options: Optional[RequestOptions] = Field(default=None, exclude=True)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
from langchain_core.utils.iter import batch_iterate
from mixedbread_ai.types import EncodingFormat, TruncationStrategy # type: ignore

from langchain_mixedbreadai.client import MixedBreadAIClient
from langchain_mixedbread_ai.client import MixedbreadAIClient

logger = logging.getLogger(__name__)


class MixedbreadAIEmbeddings(MixedBreadAIClient, Embeddings):
class MixedbreadAIEmbeddings(MixedbreadAIClient, Embeddings):
"""
Implements the Embeddings interface with Mixedbread AI's embedding API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
from langchain_core.pydantic_v1 import Field
from mixedbread_ai import RankedDocument # type: ignore

from langchain_mixedbreadai.client import MixedBreadAIClient
from langchain_mixedbread_ai.client import MixedbreadAIClient


class MixedbreadAIRerank(MixedBreadAIClient, BaseDocumentCompressor):
class MixedbreadAIRerank(MixedbreadAIClient, BaseDocumentCompressor):
"""
Document compressor that uses `Mixedbread AI Rerank API`.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ repository = "https://github.com/mixedbread-ai/langchain-mixedbread-ai"
license = "MIT"

[tool.poetry.urls]
"Source Code" = "https://github.com/mixedbread-ai/langchain-mixedbreadai.git/tree/main/libs/mixedbread-ai"
"Source Code" = "https://github.com/mixedbread-ai/langchain-mixedbread-ai.git/tree/main/libs/mixedbread-ai"

[tool.poetry.dependencies]
python = ">=3.8.1,<4.0"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

import pytest

from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings
from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings


@pytest.mark.vcr()
def test_langchain_mixedbreadai_embedding_documents() -> None:
def test_langchain_mixedbread_ai_embedding_documents() -> None:
documents = ["foo bar"]
embedding = MixedbreadAIEmbeddings()
output = embedding.embed_documents(documents)
Expand All @@ -15,7 +15,7 @@ def test_langchain_mixedbreadai_embedding_documents() -> None:


@pytest.mark.vcr()
def test_langchain_mixedbreadai_embedding_query() -> None:
def test_langchain_mixedbread_ai_embedding_query() -> None:
document = "foo bar"
embedding = MixedbreadAIEmbeddings()
output = embedding.embed_query(document)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import pytest

from langchain_mixedbreadai import MixedbreadAIRerank
from langchain_mixedbread_ai import MixedbreadAIRerank


@pytest.mark.vcr()
def test_langchain_mixedbreadai_rerank() -> None:
def test_langchain_mixedbread_ai_rerank() -> None:
texts = ["Mockingbird", "Moby-Dick"]
query = "Moby-Dick"
reranker = MixedbreadAIRerank(top_n=3)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test embedding model integration."""

from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings
from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings


def test_initialization() -> None:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from langchain_mixedbreadai import __all__
from langchain_mixedbread_ai import __all__

EXPECTED_ALL = ["MixedbreadAIEmbeddings", "MixedbreadAIRerank", "__version__"]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from langchain_mixedbreadai.rerank import MixedbreadAIRerank
from langchain_mixedbread_ai.rerank import MixedbreadAIRerank


def test_initialization() -> None:
Expand Down

0 comments on commit d04e70a

Please sign in to comment.