pyproject.toml

[tool.poetry]
    authors=["Neel Nanda <77788841+TransformerLensOrg@users.noreply.github.com>"]
    description="An implementation of transformers tailored for mechanistic interpretability."
    license="MIT"
    name="transformer-lens"
    packages=[{include="transformer_lens"}]
    readme="README.md"
    # Version is automatically set by the pipeline on release
    version="0.0.0"

    [tool.poetry.scripts]
        build-docs="docs.make_docs:build_docs"
        docs-hot-reload="docs.make_docs:docs_hot_reload"

    [tool.poetry.dependencies]
        accelerate=">=0.23.0" # Needed for Llama Models
        beartype="^0.14.1"
        better-abc="^0.0.3"
        datasets=">=2.7.1"
        einops=">=0.6.0"
        fancy-einsum=">=0.0.3"
        jaxtyping=">=0.2.11"
        numpy=[
            {version=">=1.20,<1.25", python=">=3.8,<3.9"},
            {version=">=1.24", python=">=3.9,<3.12"},
            {version=">=1.26", python=">=3.12,<3.13"},
        ]
        pandas=">=1.1.5"
        python=">=3.8,<4.0"
        rich=">=12.6.0"
        sentencepiece="*"
        torch=[
            {platform="!=linux", version=">=1.10,!=2.0,!=2.1.0"}, # Pin >=2.1.1 on Apple devices due to known MPS errors on 2.1.0
            {platform="linux", version=">=1.10"},                 # We can use any torch version on Linux (e.g colab)
        ]
        tqdm=">=4.64.1"
        transformers=">=4.37.2"
        typing-extensions="*"
        wandb=">=0.13.5"

    [tool.poetry.group]
        [tool.poetry.group.dev.dependencies]
            black="^23.3.0"
            circuitsvis=">=1.38.1"
            isort="5.8.0"
            jupyter=">=1.0.0"
            mypy=">=1.8.0"
            nbval="^0.10.0"
            plotly=">=5.12.0"
            pycln="^2.1.3"
            pytest=">=7.2.0"
            pytest-cov=">=4.0.0"
            pytest-doctestplus="^1.0.0"

        [tool.poetry.group.jupyter.dependencies]
            ipywidgets="^8.1.1"
            jupyterlab=">=3.5.0"

        [tool.poetry.group.docs.dependencies]
            furo={version=">=2022.12.7"}
            myst-parser={version=">=0.18.1"}
            nbconvert="^7.9.2"
            nbsphinx="^0.9.3"
            pandoc="^2.3"
            snowballstemmer="*"
            sphinx={version="5.2.3"}
            sphinx-autobuild={version=">=2021.3.14"}
            sphinxcontrib-napoleon={version=">=0.7"}
            tabulate={version=">=0.9.0"}

[tool.pytest]
    [tool.pytest.ini_options]
        addopts=[
            "--doctest-modules",
            "--doctest-plus",
            "--jaxtyping-packages=transformer_lens,beartype.beartype",
            "--nbval",
            "-W ignore::beartype.roar.BeartypeDecorHintPep585DeprecationWarning",
        ]
        doctest_optionflags="NORMALIZE_WHITESPACE ELLIPSIS FLOAT_CMP"
        filterwarnings=[
            "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
            # Ignore numpy.distutils deprecation warning caused by pandas
            # More info: https://numpy.org/doc/stable/reference/distutils.html#module-numpy.distutils
            "ignore:distutils Version classes are deprecated:DeprecationWarning",
        ]

[tool.isort]
    extend_skip=[".venv/", "__init__.py"]
    profile="black"

[tool.mypy]
    check_untyped_defs=true
    exclude=[".venv/", "assets", "demos", "docs", "easy_transformer", "tests"]
    ignore_missing_imports=true

[tool.black]
    line-length=100 # Set line length to 100 to match other tools
    # Exclude snapshot tests & .venv
    exclude='''
(
/snapshots/
| .venv/
)
'''

[tool.pylint]
    [tool.pylint.TYPECHECK]
        # Fix for Pytorch member existence checks
        generated-members="torch.*"

    [tool.pylint.DESIGN]
        max-args=10
        max-locals=30

    [tool.pylint."MESSAGES CONTROL"]
        disable="redefined-builtin" # Disable redefined builtin functions

    [tool.pylint.'MASTER']
        disable=[
            "C0103", # Disable invalid file name (as we use PascalCase for classes)
        ]

[build-system]
    build-backend="poetry.core.masonry.api"
    requires=["poetry-core"]

[tool.pyright]
    # All rules apart from base are shown explicitly below
    deprecateTypingAliases=true
    disableBytesTypePromotions=true
    exclude = [
        "*/**/*.py",
        "!/transformer_lens/hook_points.py"
    ]
    reportAssertAlwaysTrue=true
    reportConstantRedefinition=true
    reportDeprecated=true
    reportDuplicateImport=true
    reportFunctionMemberAccess=true
    reportGeneralTypeIssues=true
    reportIncompatibleMethodOverride=true
    reportIncompatibleVariableOverride=true
    reportIncompleteStub=true
    reportInconsistentConstructor=true
    reportInvalidStringEscapeSequence=true
    reportInvalidStubStatement=true
    reportInvalidTypeVarUse=true
    reportMatchNotExhaustive=true
    reportMissingParameterType=true
    reportMissingTypeArgument=false
    reportMissingTypeStubs=false
    reportOptionalCall=true
    reportOptionalContextManager=true
    reportOptionalIterable=true
    reportOptionalMemberAccess=true
    reportOptionalOperand=true
    reportOptionalSubscript=true
    reportOverlappingOverload=true
    reportPrivateImportUsage=true
    reportPrivateUsage=true
    reportSelfClsParameterName=true
    reportTypeCommentUsage=true
    reportTypedDictNotRequiredAccess=true
    reportUnboundVariable=true
    reportUnknownArgumentType=false
    reportUnknownLambdaType=true
    reportUnknownMemberType=false
    reportUnknownParameterType=false
    reportUnknownVariableType=false
    reportUnnecessaryCast=true
    reportUnnecessaryComparison=true
    reportUnnecessaryContains=true
    reportUnnecessaryIsInstance=true
    reportUnsupportedDunderAll=true
    reportUntypedBaseClass=true
    reportUntypedClassDecorator=true
    reportUntypedFunctionDecorator=true
    reportUntypedNamedTuple=true
    reportUnusedClass=true
    reportUnusedCoroutine=true
    reportUnusedExpression=true
    reportUnusedFunction=true
    reportUnusedImport=true
    reportUnusedVariable=true
    reportWildcardImportFromLibrary=true
    strictDictionaryInference=true
    strictListInference=true
    strictParameterNoneValue=true
    strictSetInference=true