Giter Club home page Giter Club logo

fishnet's Introduction

fishnet: distributed Stockfish analysis for lichess.org

crates.io Docker Build

Installation

  1. Request your personal fishnet key: https://lichess.org/get-fishnet

  2. Install and run the fishnet client.

    Download standalone binary

    Select the binary for your platform from the latest release and run it.

    # After download:
    mv fishnet-x86_64-unknown-linux-musl fishnet
    chmod +x fishnet
    ./fishnet --auto-update

    Useful commands

    ./fishnet configure              # Rerun config dialog
    ./fishnet systemd --auto-update  # Print a .service file
    ./fishnet --help                 # List commands and options

    Other installation methods: From source, Docker, Kubernetes, OpenShift

  3. Pick an update strategy.

    Automatic updates

    Run with --auto-update as recommended above.

    Subscribe to release announcements

    With a GitHub account, you can watch this repository (can be set to release announcements only). See the top right corner on this page.

Video introduction

Watch @arex explain fishnet.

Video introduction

FAQ

Which engine does fishnet use?

fishnet uses Stockfish (hence the name) and Fairy-Stockfish for chess variants.

What are the requirements?

Available for 64-bit Intel and AMD ARMv8 / Silicon
Linux x86_64-unknown-linux-musl aarch64-unknown-linux-musl
Windows x86_64-pc-windows-gnu.exe
macOS x86_64-apple-darwin aarch64-apple-darwin
FreeBSD build from source
  • Needs Linux or an operating system from around 2019 or later
  • Will max out the configured number of CPU cores
  • Uses about 64 MiB RAM per CPU core
  • A small amount of disk space
  • Low-bandwidth network communication with Lichess servers (only outgoing HTTP requests, so probably no firewall configuration required, IPv4 not required)

Is my CPU fast enough?

Almost all processors will be able to meet the requirement of ~2 meganodes in 6 seconds. Clients on the faster end will automatically be assigned analysis jobs that have humans waiting for the result (the user queue, as opposed to the system queue for slower clients).

Why does my client remain idle?

Your client may remain idle if fishnet estimates that another client would be able to complete the next batch more quickly, or if the client has been configured to join the queue only if a backlog is building up. By standing by, you're still contributing to reliability by providing redundancy, and also to the potential maximum throughput in case requests peak.

What happens if I stop my client?

Feel free to turn your client on and off at any time. By default, the client will try to finish any batches it has already started. On immediate shutdown, the client tries to inform Lichess that batches should be reassigned. If even that fails, Lichess will reassign the batches after a timeout.

Will fishnet use my GPU?

No, Stockfish is a classical alpha-beta engine. The neural network evaluation of Stockfish NNUE works efficiently on CPUs.

Is fishnet secure?

To the best of our knowledge. All engine input is carefully validated.

Note that you implicitly trust the authors and the GitHub and Amazon S3 infrastructure when running with --auto-update. You can mitigate this by running fishnet as an unprivileged user.

cargo-crev is used to review the trustworthiness of dependencies. cargo-auditable is used to embed dependency meta data into binaries.

Is there a leaderboard of contributors?

No, sorry, not publicly. It would incentivize gaming the metrics.

Can I autoscale fishnet in the cloud?

There is currently no ready-made solution, but an API for monitoring the job queue status is provided.

Protocol

Sequence diagram

See protocol.md for details. Also supports SSLKEYLOGFILE for inspection at runtime.

License

fishnet is licensed under the GPLv3+. See LICENSE.txt or ./fishnet license for the full license text.

fishnet's People

Contributors

niklasf avatar ornicar avatar toughiq avatar lukhas avatar ankitshahit avatar amotmot avatar sethtroisi avatar ddugovic avatar kdave avatar lakinwecker avatar bharrisau avatar kriolyth avatar richienb avatar obj-obj avatar cubox avatar benediktwerner avatar voteblake avatar thesilican avatar eolo999 avatar flevour avatar franciscouzo avatar kindrebelg avatar wrigjl avatar islandc0der avatar eeqk avatar larb0b avatar bykow avatar lgommans avatar nobriot avatar ageneau avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.