From 2f888007498542cde99e04af7ea1e6f747a49740 Mon Sep 17 00:00:00 2001 From: Heng Pan Date: Thu, 20 Jun 2024 13:23:53 +0100 Subject: [PATCH] refactor(framework:skip) Append the doc string of `StateFactory` (#3648) --- src/py/flwr/server/superlink/state/state_factory.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/py/flwr/server/superlink/state/state_factory.py b/src/py/flwr/server/superlink/state/state_factory.py index 62a00d910828..51f5bf5e2ee2 100644 --- a/src/py/flwr/server/superlink/state/state_factory.py +++ b/src/py/flwr/server/superlink/state/state_factory.py @@ -26,7 +26,16 @@ class StateFactory: - """Factory class that creates State instances.""" + """Factory class that creates State instances. + + Parameters + ---------- + database : str + A string representing the path to the database file that will be opened. + Note that passing ':memory:' will open a connection to a database that is + in RAM, instead of on disk. For more information on special in-memory + databases, please refer to https://sqlite.org/inmemorydb.html. + """ def __init__(self, database: str) -> None: self.database = database