v0.5.0

Released on December 18, 2023

Description

• Unpin the Intel Fortran compiler in CI/CD
• Added a missing space in an error message
• Improved consistency of namespace declarations for C++ pybind
  interface
• Improved const correctness of C++ Client
• Improved const correctness of C++ Dataset
• Updated documentation
• Added test cases for all Client construction parameter combinations
• Centralized dependency tracking to setup.cfg
• Improved robustness of Python client construction
• Updated Client and Dataset documentation
• Expanded list of allowed characters in the SSDB address
• Added coverage to SmartRedis Python API functions
• Improved responsiveness of library when attempting connection to
  missing backend database
• Moved testing of examples to on-commit testing in CI/CD pipeline
• Added name retrieval function to the DataSet object
• Updated RedisAI version used in post-commit check-in testing in
  Github pipeline
• Allow strings in Python interface for Client.run_script,
  Client.run_script_multiGPU
• Improved support for model execution batching
• Added support for model chunking
• Updated the third-party RedisAI component
• Updated the third-party lcov component
• Add link to contributing guidelines
• Added link to contributing guidelines
• Added support for multiple backend databases via a new Client
  constructor that accepts a ConfigOptions object

Detailed Notes

• Unpin the Intel Fortran compiler in CI/CD. This requires running the
  compiler setup script twice, once for Fortran and once for other
  languages, since they're on different releases
  (PR436)
• Added a missing space in an error message
  (PR435)
• Made the declaration of the py namespace in py*.h consistently
  outside the SmartRedis namespace declaration
  (PR434)
• Fields in several C++ API methods are now properly marked as const
  (PR430)
• The Dataset add_tensor method is now const correct, as are all
  internal the methods it calls
  (PR427)
• Some broken links in the documentation were fixed, and the
  instructions to run the tests were updated
  (PR423)
• Added test cases for all Client construction parameter combinations
  (PR422)
• Merged dependency lists from requirements.txt and
  requirements-dev.txt into setup.cfg to have only one set of
  dependencies going forward
  (PR420)
• Improved robustness of Python client construction by adding
  detection of invalid kwargs
  (PR419),
  (PR421)
• Updated the Client and Dataset API documentation to clarify which
  interacts with the backend db
  (PR416)
• The SSDB address can now include '-' and '_' as special characters
  in the name. This gives users more options for naming the UDS socket
  file (PR415)
• Added tests to increase Python code coverage
• Employed a Redis++ ConnectionsObject in the connection process to
  establish a TCP timeout of 100ms during connection attempts
  (PR413)
• Moved testing of examples to on-commit testing in CI/CD pipeline
  (PR412)
• Added a function to the DataSet class and added a test
• Updated RedisAI version used in post-commit check-in testing in
  Github pipeline to a version that supports fetch of model chunking
  size (PR408)
• Allow users to pass single keys for the inputs and outputs
  parameters as a string for Python run_script and run_script_multigpu
• Exposed access to the Redis.AI MINBATCHTIMEOUT parameter, which
  limits the delay in model execution when trying to accumulate
  multiple executions in a batch
  (PR406)
• Models will now be automatically chunked when sent to/received from
  the backed database. This allows use of models greater than 511MB in
  size. (PR404)
• Updated from RedisAI v1.2.3 (test target)/v1.2.4 and v1.2.5 (CI/CD
  pipeline) to v1.2.7
  (PR402)
• Updated lcov from version 1.15 to 2.0
  (PR396)
• Create CONTRIBUTIONS.md file that points to the contribution
  guideline for both SmartSim and SmartRedis
  (PR395)
• Migrated to ConfigOptions-based Client construction, adding multiple
  database support
  (PR353)