Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 3.46 KB

README.md

File metadata and controls

73 lines (53 loc) · 3.46 KB
Raw

swarms-core

CI Coverage pypi versions license

This package provides the core functionality for Swarms exeuction strategies utilizing RUST.

Install

pip3 install -U swarms-core

Getting Started

You'll need rust stable installed, or rust nightly if you want to generate accurate coverage.

With rust and python 3.8+ installed, compiling swarms-core should be possible with roughly the following:

# clone this repo or your fork
git clone git@github.com:kyegomez/swarms-core.git
cd swarms-core
# create a new virtual env
python3 -m venv env
source env/bin/activate
# install dependencies and install swarms-core
make install

That should be it, the example shown above should now run.

You might find it useful to look at python/pydantic_core/_pydantic_core.pyi and python/pydantic_core/core_schema.py for more information on the python API, beyond that, tests/ provide a large number of examples of usage.

If you want to contribute to swarms-core, you'll want to use some other make commands:

  • make build-dev to build the package during development
  • make build-prod to perform an optimised build for benchmarking
  • make test to run the tests
  • make testcov to run the tests and generate a coverage report
  • make lint to run the linter
  • make format to format python and rust code
  • make to run format build-dev lint test

Test Profiling

It's possible to profile the code using the flamegraph utility from flamegraph-rs. (Tested on Linux.) You can install this with cargo install flamegraph.

Run make build-profiling to install a release build with debugging symbols included (needed for profiling).

Once that is built, you can profile pytest benchmarks with (e.g.):

flamegraph -- pytest tests/benchmarks/test_micro_benchmarks.py -k test_list_of_ints_core_py --benchmark-enable

The flamegraph command will produce an interactive SVG at flamegraph.svg.

Releasing

  1. Bump package version locally. Do not just edit Cargo.toml on Github, you need both Cargo.toml and Cargo.lock to be updated.
  2. Make a PR for the version bump and merge it.
  3. Go to https://github.com/kyegomez/swarms-core/releases and click "Draft a new release"
  4. In the "Choose a tag" dropdown enter the new tag v<the.new.version> and select "Create new tag on publish" when the option appears.
  5. Enter the release title in the form "v<the.new.version> "
  6. Click Generate release notes button
  7. Click Publish release
  8. Go to https://github.com/kyegomez/swarms-core/actions and ensure that all build for release are done successfully.
  9. Go to https://pypi.org/project/swarms-core/ and ensure that the latest release is published.
  10. Done 🎉