OptunaSharp.Storage.StackExchange.Redis 1.0.0

dotnet add package OptunaSharp.Storage.StackExchange.Redis --version 1.0.0
                    
NuGet\Install-Package OptunaSharp.Storage.StackExchange.Redis -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OptunaSharp.Storage.StackExchange.Redis" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OptunaSharp.Storage.StackExchange.Redis" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="OptunaSharp.Storage.StackExchange.Redis" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OptunaSharp.Storage.StackExchange.Redis --version 1.0.0
                    
#r "nuget: OptunaSharp.Storage.StackExchange.Redis, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package OptunaSharp.Storage.StackExchange.Redis@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=OptunaSharp.Storage.StackExchange.Redis&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=OptunaSharp.Storage.StackExchange.Redis&version=1.0.0
                    
Install as a Cake Tool

OptunaSharp.Storage.StackExchange.Redis

Redis journal-log backend for OptunaSharp on StackExchange.Redis — the de-facto-standard .NET Redis client (MIT). Part of the SciSharp STACK.

StackExchangeJournalRedisBackend persists an Optuna study's operation log to a Redis server (standalone or cluster). It is byte-compatible with Python Optuna's optuna.storages.journal.JournalRedisBackend and with the sibling NRedisStack/ServiceStack backends — a study written by any of them can be read by the others over the same Redis.

Usage

using OptunaSharp.Storages;
using OptunaSharp.Storages.Journal;

var backend = new StackExchangeJournalRedisBackend("redis://localhost:6379");
var study = Optuna.CreateStudy(storage: new JournalStorage(backend));
study.Optimize(t => { var x = t.SuggestFloat("x", -10, 10); return (x - 2) * (x - 2); }, nTrials: 20);

redis://, rediss:// (TLS) and unix:// URLs are accepted (optional [user]:[pass]@, /db, ?db=). For a cluster, pass useCluster: true.

Native StackExchange.Redis configuration

The URL constructor mirrors Python Optuna, but you are not limited to it — drive StackExchange.Redis on its own terms. Four constructors, all taking the same useCluster / prefix:

// 1. redis-py-style URL (Optuna-identical)
new StackExchangeJournalRedisBackend("redis://localhost:6379");

// 2. keep the URL, tweak the derived ConfigurationOptions
new StackExchangeJournalRedisBackend("redis://localhost:6379", o =>
{
    o.ConnectTimeout = 5000;
    o.ClientName     = "my-app";
    o.ConnectRetry   = 3;
});

// 3. a ConfigurationOptions you built yourself (timeouts, retry policy, TLS certs, CommandMap, …)
var options = new ConfigurationOptions { EndPoints = { "localhost:6379" }, Ssl = true, ClientName = "my-app" };
new StackExchangeJournalRedisBackend(options);

// 4. an IConnectionMultiplexer you already own (pooled / shared / DI-managed — you keep its lifetime)
new StackExchangeJournalRedisBackend(existingMultiplexer);

The on-wire journal format is fixed regardless of how you connect, so the study stays byte-compatible with Python Optuna and the sibling backends whichever constructor you use.

License

MIT © SciSharp STACK Team. (StackExchange.Redis is MIT.)

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 58 11/8/2026