usearch 2.9.1 → 2.10.0

package/.github/workflows/update_version.sh

@@ -1,15 +0,0 @@
-#!/bin/sh
-
-echo $1 > VERSION && 
-    sed -i "s/\"version\": \".*\"/\"version\": \"$1\"/" package.json &&
-    sed -i "s/^version: .*/version: $1/" CITATION.cff &&
-    sed -i "s/version = \".*\"/version = \"$1\"/" Cargo.toml &&
-    sed -i "s/version = '.*'/version = '$1'/" conanfile.py &&
-    sed -i "s/^\(#define USEARCH_VERSION_MAJOR \).*/\1$(echo "$1" | cut -d. -f1)/" ./include/usearch/index.hpp &&
-    sed -i "s/^\(#define USEARCH_VERSION_MINOR \).*/\1$(echo "$1" | cut -d. -f2)/" ./include/usearch/index.hpp &&
-    sed -i "s/^\(#define USEARCH_VERSION_PATCH \).*/\1$(echo "$1" | cut -d. -f3)/" ./include/usearch/index.hpp &&
-    sed -i "s/<version>[0-9]\+\.[0-9]\+\.[0-9]\+/<version>$1/" README.md &&
-    sed -i "s/version = {[0-9]\+\.[0-9]\+\.[0-9]\+}/version = {$1}/" README.md &&
-    sed -i "s/>[0-9]\+\.[0-9]\+\.[0-9]\+<\/Version>/>$1<\/Version>/" ./csharp/nuget/nuget-package.props &&
-    sed -i "s/VERSION [0-9]\+\.[0-9]\+\.[0-9]\+/VERSION $1/" CMakeLists.txt &&
-    sed -i "s/version=\".*\"/version=\"$1\"/" wasmer.toml

package/.gitmodules

@@ -1,9 +0,0 @@
-[submodule "simsimd"]
-	path = simsimd
-	url = https://github.com/ashvardanian/simsimd
-[submodule "fp16"]
-	path = fp16
-	url = https://github.com/maratyszcza/fp16
-[submodule "stringzilla"]
-	path = stringzilla
-	url = https://github.com/ashvardanian/stringzilla

package/.releaserc

@@ -1,90 +0,0 @@
-{
-    "branches": [
-        "main"
-    ],
-    "debug": true,
-    "ci": true,
-    "dryRun": false,
-    "plugins": [
-        [
-            "@semantic-release/commit-analyzer",
-            {
-                "preset": "eslint",
-                "releaseRules": [
-                    {
-                        "tag": "Break",
-                        "release": "major"
-                    },
-                    {
-                        "tag": "Add",
-                        "release": "minor"
-                    },
-                    {
-                        "tag": "Improve",
-                        "release": "patch"
-                    },
-                    {
-                        "tag": "Make",
-                        "release": "patch"
-                    },
-                    {
-                        "tag": "Refactor",
-                        "release": false
-                    }
-                ]
-            }
-        ],
-        [
-            "@semantic-release/release-notes-generator",
-            {
-                "preset": "eslint",
-                "releaseRules": [
-                    {
-                        "tag": "Break",
-                        "release": "major"
-                    },
-                    {
-                        "tag": "Add",
-                        "release": "minor"
-                    },
-                    {
-                        "tag": "Improve",
-                        "release": "patch"
-                    },
-                    {
-                        "tag": "Make",
-                        "release": "patch"
-                    },
-                    {
-                        "tag": "Refactor",
-                        "release": false
-                    }
-                ]
-            }
-        ],
-        "@semantic-release/github",
-        [
-            "@semantic-release/exec",
-            {
-                "prepareCmd": "bash .github/workflows/update_version.sh '${nextRelease.version}'"
-            }
-        ],
-        [
-            "@semantic-release/git",
-            {
-                "assets": [
-                    "VERSION",
-                    "conanfile.py",
-                    "package.json",
-                    "Cargo.toml",
-                    "wasmer.toml",
-                    "./include/usearch/index.hpp",
-                    "README.md",
-                    "./csharp/nuget/nuget-package.props",
-                    "CITATION.cff"
-                ],
-                "message": "Build: Released ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-            }
-        ]
-    ]
-}

package/CITATION.cff

@@ -1,11 +0,0 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
-authors:
-- family-names: "Vardanian"
-  given-names: "Ash"
-  orcid: "https://orcid.org/0000-0002-4882-1815"
-title: "USearch by Unum Cloud"
-version: 2.9.1
-doi: 10.5281/zenodo.7949416
-date-released: 2023-10-22
-url: "https://github.com/unum-cloud/usearch"

package/CMakeLists.txt

@@ -1,324 +0,0 @@
-# This CMake file is heavily inspired by following `usearch` CMake:
-# https://github.com/nlohmann/json/blob/develop/CMakeLists.txt
-cmake_minimum_required(VERSION 3.1)
-project(
-    usearch
-    VERSION 2.7.2
-    LANGUAGES C CXX
-)
-
-# Determine if USearch is built as a subproject (using `add_subdirectory`) or if it is the main project
-set(USEARCH_IS_MAIN_PROJECT OFF)
-if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-    set(USEARCH_IS_MAIN_PROJECT ON)
-endif ()
-
-# Allow CMake 3.13+ to override options when using FetchContent / add_subdirectory
-if (POLICY CMP0077)
-    cmake_policy(SET CMP0077 NEW)
-endif ()
-
-# Options
-option(USEARCH_INSTALL "Install CMake targets" OFF)
-
-option(USEARCH_USE_OPENMP "Use OpenMP for a thread pool" OFF)
-option(USEARCH_USE_SIMSIMD "Use SimSIMD hardware-accelerated metrics" OFF)
-option(USEARCH_USE_JEMALLOC "Use JeMalloc for faster memory allocations" OFF)
-option(USEARCH_USE_FP16LIB "Use software emulation for half-precision types" ON)
-
-option(USEARCH_BUILD_TEST_CPP "Compile a native unit test in C++" ${USEARCH_IS_MAIN_PROJECT})
-option(USEARCH_BUILD_BENCH_CPP "Compile a native benchmark in C++" ${USEARCH_IS_MAIN_PROJECT})
-option(USEARCH_BUILD_LIB_C "Compile a native library for the C 99 interface" OFF)
-option(USEARCH_BUILD_TEST_C "Compile a test for the C 99 interface" OFF)
-option(USEARCH_BUILD_WOLFRAM "Compile Wolfram Language bindings" OFF)
-
-# Includes
-set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
-include(ExternalProject)
-
-# Configuration
-include(GNUInstallDirs)
-set(USEARCH_TARGET_NAME ${PROJECT_NAME})
-set(USEARCH_CONFIG_INSTALL_DIR
-    "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}"
-    CACHE INTERNAL ""
-)
-set(USEARCH_INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}")
-set(USEARCH_TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets")
-set(USEARCH_CMAKE_CONFIG_TEMPLATE "cmake/config.cmake.in")
-set(USEARCH_CMAKE_CONFIG_DIR "${CMAKE_CURRENT_BINARY_DIR}")
-set(USEARCH_CMAKE_VERSION_CONFIG_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
-set(USEARCH_CMAKE_PROJECT_CONFIG_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake")
-set(USEARCH_CMAKE_PROJECT_TARGETS_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Targets.cmake")
-set(USEARCH_PKGCONFIG_INSTALL_DIR "${CMAKE_INSTALL_DATADIR}/pkgconfig")
-
-# Define our header-only library
-add_library(${USEARCH_TARGET_NAME} INTERFACE)
-add_library(${PROJECT_NAME}::${USEARCH_TARGET_NAME} ALIAS ${USEARCH_TARGET_NAME})
-set(USEARCH_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/include/")
-if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
-    target_compile_features(${USEARCH_TARGET_NAME} INTERFACE cxx_range_for)
-else ()
-    target_compile_features(${USEARCH_TARGET_NAME} INTERFACE cxx_std_11)
-endif ()
-
-# Core compilation settings affecting "index.hpp"
-target_compile_definitions(
-    ${USEARCH_TARGET_NAME} INTERFACE $<$<NOT:$<BOOL:${USEARCH_USE_OPENMP}>>:USEARCH_USE_OPENMP=0>
-)
-
-# Supplementary compilation settings affecting "index_plugins.hpp"
-target_compile_definitions(
-    ${USEARCH_TARGET_NAME} INTERFACE $<$<NOT:$<BOOL:${USEARCH_USE_FP16LIB}>>:USEARCH_USE_FP16LIB=1>
-)
-
-target_compile_definitions(
-    ${USEARCH_TARGET_NAME} INTERFACE $<$<NOT:$<BOOL:${USEARCH_USE_SIMSIMD}>>:USEARCH_USE_SIMSIMD=0>
-)
-
-target_include_directories(
-    ${USEARCH_TARGET_NAME} ${USEARCH_SYSTEM_INCLUDE} INTERFACE $<BUILD_INTERFACE:${USEARCH_INCLUDE_BUILD_DIR}>
-                                                               $<INSTALL_INTERFACE:include>
-)
-
-# Install a pkg-config file, so other tools can find this
-configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc")
-
-# Install a custom package version config file instead of write_basic_package_version_file to ensure that it's
-# architecture-independent https://github.com/nlohmann/json/issues/1697
-include(CMakePackageConfigHelpers)
-configure_file("cmake/usearchConfigVersion.cmake.in" ${USEARCH_CMAKE_VERSION_CONFIG_FILE} @ONLY)
-configure_file(${USEARCH_CMAKE_CONFIG_TEMPLATE} ${USEARCH_CMAKE_PROJECT_CONFIG_FILE} @ONLY)
-
-if (USEARCH_INSTALL)
-    install(DIRECTORY ${USEARCH_INCLUDE_BUILD_DIR} DESTINATION ${USEARCH_INCLUDE_INSTALL_DIR})
-    install(FILES ${USEARCH_CMAKE_PROJECT_CONFIG_FILE} ${USEARCH_CMAKE_VERSION_CONFIG_FILE}
-            DESTINATION ${USEARCH_CONFIG_INSTALL_DIR}
-    )
-    export(
-        TARGETS ${USEARCH_TARGET_NAME}
-        NAMESPACE ${PROJECT_NAME}::
-        FILE ${USEARCH_CMAKE_PROJECT_TARGETS_FILE}
-    )
-    install(
-        TARGETS ${USEARCH_TARGET_NAME}
-        EXPORT ${USEARCH_TARGETS_EXPORT_NAME}
-        INCLUDES
-        DESTINATION ${USEARCH_INCLUDE_INSTALL_DIR}
-    )
-    install(
-        EXPORT ${USEARCH_TARGETS_EXPORT_NAME}
-        NAMESPACE ${PROJECT_NAME}::
-        DESTINATION ${USEARCH_CONFIG_INSTALL_DIR}
-    )
-    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc" DESTINATION ${USEARCH_PKGCONFIG_INSTALL_DIR})
-endif ()
-
-# Find required packages
-if (CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin")
-    set(CMAKE_THREAD_LIBS_INIT "-lpthread")
-    set(CMAKE_HAVE_THREADS_LIBRARY 1)
-    set(CMAKE_USE_WIN32_THREADS_INIT 0)
-    set(CMAKE_USE_PTHREADS_INIT 1)
-    set(THREADS_PREFER_PTHREAD_FLAG ON)
-endif ()
-find_package(Threads REQUIRED)
-
-if (USEARCH_USE_OPENMP)
-    find_package(OpenMP REQUIRED)
-endif ()
-
-if (USEARCH_USE_JEMALLOC)
-    include(jemalloc)
-endif ()
-
-# Set default build type to Release
-if (NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE RelWithDebInfo)
-endif ()
-
-# Include directories
-set(USEARCH_HEADER_INCLUDES "${CMAKE_CURRENT_SOURCE_DIR}/include" "${CMAKE_CURRENT_SOURCE_DIR}/fp16/include"
-                            "${CMAKE_CURRENT_SOURCE_DIR}/simsimd/include"
-)
-
-# Function to setup target
-function (setup_target TARGET_NAME)
-    # Compiler-specific options List of all possible compiler IDs:
-    # https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
-    if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-        target_compile_options(
-            ${TARGET_NAME}
-            PRIVATE $<$<CONFIG:RELEASE>:-O3>
-                    $<$<CONFIG:RELWITHDEBINFO>:-O3
-                    -g>
-                    $<$<CONFIG:DEBUG>:-g
-                    -fsanitize=address
-                    -fsanitize=leak
-                    -fsanitize=alignment
-                    -fsanitize=undefined
-                    >
-                    -ffast-math
-                    -fPIC
-                    -Wall
-                    -Wextra
-                    -Wno-conversion
-                    -Wno-unknown-pragmas
-                    -march=native
-                    -fmax-errors=1
-                    -pedantic
-                    -fdiagnostics-color=always
-                    -ftime-report
-        )
-        target_link_options(
-            ${TARGET_NAME}
-            PRIVATE
-            $<$<CONFIG:DEBUG>:-g
-            -fsanitize=address
-            -fsanitize=leak
-            -fsanitize=alignment
-            -fsanitize=undefined
-            >
-            -fPIC
-        )
-
-        if (USEARCH_USE_OPENMP)
-            target_link_libraries(${TARGET_NAME} PRIVATE OpenMP::OpenMP_CXX)
-        endif ()
-
-        target_link_libraries(${TARGET_NAME} PRIVATE Threads::Threads)
-
-    elseif (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-        target_compile_options(
-            ${TARGET_NAME}
-            PRIVATE $<$<CONFIG:RELEASE>:-O3>
-                    $<$<CONFIG:RELWITHDEBINFO>:-O3
-                    -g>
-                    $<$<CONFIG:DEBUG>:-g
-                    -fsanitize=address
-                    -fsanitize=alignment
-                    -fsanitize=undefined
-                    >
-                    -ffast-math
-                    -fPIC
-                    -pedantic
-                    -Wfatal-errors
-                    # Don't complain if the for-loops were not vectorzied
-                    -Wpass-failed=transform-warning
-                    -fcolor-diagnostics
-                    -ftime-trace
-        )
-        target_link_options(
-            ${TARGET_NAME}
-            PRIVATE
-            $<$<CONFIG:DEBUG>:-g
-            -fsanitize=address
-            -fsanitize=alignment
-            -fsanitize=undefined
-            >
-            -fPIC
-        )
-
-        # Check if the compiler is AppleClang, and if not, add the leak sanitizer
-        if (CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin")
-            # It's likely AppleClang Adjust options as needed for AppleClang
-        else ()
-            # It's likely LLVM Clang
-            target_compile_options(${TARGET_NAME} PRIVATE $<$<CONFIG:DEBUG>:-fsanitize=leak>)
-            target_link_options(${TARGET_NAME} PRIVATE $<$<CONFIG:DEBUG>:-fsanitize=leak>)
-        endif ()
-
-        if (USEARCH_USE_OPENMP)
-            target_link_libraries(${TARGET_NAME} PRIVATE OpenMP::OpenMP_CXX)
-        endif ()
-
-        if (CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin")
-            target_link_libraries(
-                ${TARGET_NAME} PRIVATE "-framework CoreFoundation" "-framework Security" Threads::Threads
-            )
-        else ()
-            target_link_libraries(${TARGET_NAME} PRIVATE Threads::Threads)
-        endif ()
-
-    elseif (CMAKE_CXX_COMPILER_ID STREQUAL "NVIDIA" OR CMAKE_CXX_COMPILER_ID STREQUAL "NVHPC")
-        target_compile_options(${TARGET_NAME} PRIVATE $<$<CONFIG:RELEASE>:-O3>)
-        target_compile_definitions(${TARGET_NAME} PRIVATE --expt-relaxed-constexpr --extended-lambda)
-        set_property(SOURCE bench.cpp PROPERTY LANGUAGE CUDA)
-        set_target_properties(${TARGET_NAME} PROPERTIES POSITION_INDEPENDENT_CODE ON)
-        set_target_properties(${TARGET_NAME} PROPERTIES CUDA_ARCHITECTURES "86")
-
-    elseif (CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
-        target_compile_options(${TARGET_NAME} PRIVATE -w -ferror-limit=1)
-
-    elseif (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-        target_compile_options(
-            ${TARGET_NAME} PRIVATE $<$<CONFIG:DEBUG>:/DEBUG> $<$<CONFIG:RELEASE>:/O2> $<$<CONFIG:RELWITHDEBINFO>:/O2
-                                   /DEBUG>
-        )
-    endif ()
-
-    target_include_directories(${TARGET_NAME} PRIVATE ${USEARCH_HEADER_INCLUDES})
-    set_target_properties(${TARGET_NAME} PROPERTIES CXX_STANDARD 17)
-
-    # On Windows, when using multi-configuration CMake builds, the paths will be nested, resulting in
-    # "build_debug\Debug" on Windows instead of "build_debug". That's why we override all the configs to use the same
-    # output directory.
-    set_target_properties(
-        ${TARGET_NAME}
-        PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}"
-                   ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}"
-                   LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}"
-    )
-    set_target_properties(
-        ${TARGET_NAME}
-        PROPERTIES RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}"
-                   ARCHIVE_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}"
-                   LIBRARY_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}"
-    )
-    set_target_properties(
-        ${TARGET_NAME}
-        PROPERTIES RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}"
-                   ARCHIVE_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}"
-                   LIBRARY_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}"
-    )
-    set_target_properties(
-        ${TARGET_NAME}
-        PROPERTIES RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}"
-                   ARCHIVE_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}"
-                   LIBRARY_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}"
-    )
-
-    # On Linux and MacOS our primary shared libraries for C are called `libusearch_c.so` and `libusearch_c.dylib`, while
-    # on Windows the "lib" prefix might be missing by default, so let's ensure it's always there
-    get_target_property(TARGET_TYPE ${TARGET_NAME} TYPE)
-    if (TARGET_TYPE STREQUAL "SHARED_LIBRARY" OR TARGET_TYPE STREQUAL "STATIC_LIBRARY")
-        set_target_properties(${TARGET_NAME} PROPERTIES PREFIX "lib")
-    endif ()
-
-    # Core compilation settings affecting "index.hpp"
-    target_compile_definitions(${TARGET_NAME} PRIVATE $<$<NOT:$<BOOL:${USEARCH_USE_OPENMP}>>:USEARCH_USE_OPENMP=0>)
-
-    # Supplementary compilation settings affecting "index_plugins.hpp"
-    target_compile_definitions(
-        ${TARGET_NAME} PRIVATE $<$<NOT:$<BOOL:${USEARCH_USE_FP16LIB}>>:USEARCH_USE_FP16LIB=1>
-    )
-
-    target_compile_definitions(${TARGET_NAME} PRIVATE $<$<NOT:$<BOOL:${USEARCH_USE_SIMSIMD}>>:USEARCH_USE_SIMSIMD=0>)
-
-endfunction ()
-
-if (${USEARCH_BUILD_TEST_CPP} OR ${USEARCH_BUILD_BENCH_CPP})
-    add_subdirectory(cpp)
-endif ()
-
-if (${USEARCH_BUILD_WOLFRAM})
-    add_subdirectory(wolfram)
-endif ()
-
-if (${USEARCH_BUILD_WASM})
-    add_subdirectory(wasm)
-endif ()
-
-if (${USEARCH_BUILD_LIB_C} OR ${USEARCH_BUILD_TEST_C})
-    add_subdirectory(c)
-endif ()

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-info@unum.cloud.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.