flwr-nightly 1.5.0.dev20230421__py3-none-any.whl → 1.5.0.dev20230427__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
flwr/server/app.py CHANGED
@@ -590,7 +590,12 @@ def _validate_ssl_files(
590
590
  def _parse_args_driver() -> argparse.ArgumentParser:
591
591
  """Parse command line arguments for Driver API."""
592
592
  parser = argparse.ArgumentParser(
593
- description="Start Flower server (Driver API)",
593
+ description="Start a Flower Driver API server. "
594
+ "This server will be responsible for "
595
+ "receiving TaskIns from the Driver script and "
596
+ "sending them to the Fleet API. Once the client nodes "
597
+ "are done, they will send the TaskRes back to this Driver API server (through"
598
+ " the Fleet API) which will then send them back to the Driver script.",
594
599
  )
595
600
 
596
601
  _add_args_common(parser=parser)
@@ -602,7 +607,12 @@ def _parse_args_driver() -> argparse.ArgumentParser:
602
607
  def _parse_args_fleet() -> argparse.ArgumentParser:
603
608
  """Parse command line arguments for Fleet API."""
604
609
  parser = argparse.ArgumentParser(
605
- description="Start Flower server (Fleet API)",
610
+ description="Start a Flower Fleet API server."
611
+ "This server will be responsible for "
612
+ "sending TaskIns (received from the Driver API) to the client nodes "
613
+ "and of receiving TaskRes sent back from those same client nodes once "
614
+ "they are done. Then, this Fleet API server can send those "
615
+ "TaskRes back to the Driver API.",
606
616
  )
607
617
 
608
618
  _add_args_common(parser=parser)
@@ -614,7 +624,9 @@ def _parse_args_fleet() -> argparse.ArgumentParser:
614
624
  def _parse_args_server() -> argparse.ArgumentParser:
615
625
  """Parse command line arguments for both Driver API and Fleet API."""
616
626
  parser = argparse.ArgumentParser(
617
- description="Start Flower server (Driver API and Fleet API)",
627
+ description="This will start a Flower server "
628
+ "(meaning, a Driver API and a Fleet API), "
629
+ "that clients will be able to connect to.",
618
630
  )
619
631
 
620
632
  _add_args_common(parser=parser)
@@ -627,7 +639,11 @@ def _parse_args_server() -> argparse.ArgumentParser:
627
639
  def _add_args_common(parser: argparse.ArgumentParser) -> None:
628
640
  parser.add_argument(
629
641
  "--database",
630
- help=f"Flower server database. Default: {DATABASE}",
642
+ help="A string representing the path to the database "
643
+ "file that will be opened. Note that passing ':memory:' "
644
+ "will open a connection to a database that is in RAM, "
645
+ "instead of on disk. If nothing is provided, "
646
+ "Flower will just create a state in memory.",
631
647
  default=DATABASE,
632
648
  )
633
649
 
@@ -635,7 +651,8 @@ def _add_args_common(parser: argparse.ArgumentParser) -> None:
635
651
  def _add_args_driver_api(parser: argparse.ArgumentParser) -> None:
636
652
  parser.add_argument(
637
653
  "--driver-api-address",
638
- help=f"Driver API gRPC server address. Default: {ADDRESS_DRIVER_API}",
654
+ help="The Driver API gRPC server address, which can be an IPv4, "
655
+ "IPv6, or a domain name.",
639
656
  default=ADDRESS_DRIVER_API,
640
657
  )
641
658
 
@@ -649,7 +666,8 @@ def _add_args_fleet_api(parser: argparse.ArgumentParser) -> None:
649
666
  dest="fleet_api_type",
650
667
  const="grpc",
651
668
  default="grpc",
652
- help="Start a gRPC-based Fleet API server",
669
+ help="Start a gRPC-based Fleet API server "
670
+ "(which is the default if no argument is provided).",
653
671
  )
654
672
  ex_group.add_argument(
655
673
  "--rest",
@@ -663,7 +681,8 @@ def _add_args_fleet_api(parser: argparse.ArgumentParser) -> None:
663
681
  grpc_group = parser.add_argument_group("Fleet API gRPC server options", "")
664
682
  grpc_group.add_argument(
665
683
  "--grpc-fleet-api-address",
666
- help=f"Fleet API gRPC server address. Default:'{ADDRESS_FLEET_API_GRPC_RERE}'",
684
+ help="The Fleet API gRPC server address, which can be an IPv4, "
685
+ "IPv6, or a domain name.",
667
686
  default=ADDRESS_FLEET_API_GRPC_RERE,
668
687
  )
669
688
 
@@ -671,22 +690,25 @@ def _add_args_fleet_api(parser: argparse.ArgumentParser) -> None:
671
690
  rest_group = parser.add_argument_group("Fleet API REST server options", "")
672
691
  rest_group.add_argument(
673
692
  "--rest-fleet-api-address",
674
- help=f"Fleet API REST server address. Default:'{ADDRESS_FLEET_API_REST}'",
693
+ help="The Fleet API REST server address, which can be an IPv4, "
694
+ "IPv6, or a domain name.",
675
695
  default=ADDRESS_FLEET_API_REST,
676
696
  )
677
697
  rest_group.add_argument(
678
698
  "--ssl-certfile",
679
- help="Fleet API REST SSL certificate file (as a path str). Default:None",
699
+ help="Fleet API REST server SSL certificate file (as a path str), "
700
+ "needed for using 'https'.",
680
701
  default=None,
681
702
  )
682
703
  rest_group.add_argument(
683
704
  "--ssl-keyfile",
684
- help="Fleet API REST SSL private key file (as a path str). Default:None",
705
+ help="Fleet API REST server SSL private key file (as a path str), "
706
+ "needed for using 'https'.",
685
707
  default=None,
686
708
  )
687
709
  rest_group.add_argument(
688
710
  "--rest-fleet-api-workers",
689
- help=f"Number of workers for Fleet API REST server. Default:'{1}'",
711
+ help="Set the number of concurrent workers for the Fleet API REST server.",
690
712
  type=int,
691
713
  default=1,
692
714
  )
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: flwr-nightly
3
- Version: 1.5.0.dev20230421
3
+ Version: 1.5.0.dev20230427
4
4
  Summary: Flower: A Friendly Federated Learning Framework
5
5
  Home-page: https://flower.dev
6
6
  License: Apache-2.0
@@ -48,7 +48,7 @@ flwr/proto/transport_pb2_grpc.py,sha256=vLN3EHtx2aEEMCO4f1Upu-l27BPzd3-5pV-u8wPc
48
48
  flwr/proto/transport_pb2_grpc.pyi,sha256=AGXf8RiIiW2J5IKMlm_3qT3AzcDa4F3P5IqUjve_esA,766
49
49
  flwr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
50
50
  flwr/server/__init__.py,sha256=fDk0_Aa1UkPBnhgAteeQv42KQyxSgU4JsF7le9gvVyY,1370
51
- flwr/server/app.py,sha256=2BZNiSpAz95dcJs0LJxOkoHO1E2mXLJDd5rM5EHJImI,22380
51
+ flwr/server/app.py,sha256=QHptvgsG3v0q53orxw_ITkaTsA_MidzjPML5Q5AcpnA,23569
52
52
  flwr/server/client_manager.py,sha256=OjJsIFos4kgol_knpGLa2IVCnFQJ1NuN-Qdr5BD6lYU,5941
53
53
  flwr/server/client_proxy.py,sha256=f0XnGrhaBzWsKN7j0KD288GqlebhVeJuSOMN38cD8Dc,2228
54
54
  flwr/server/criterion.py,sha256=9qfnUrDzgPhF8XIeBzJc1TrGrAmHOgAq24BEmZRN5BQ,1058
@@ -97,8 +97,8 @@ flwr/simulation/__init__.py,sha256=ZtAt5bMbbp9IJp1QQOhACN6_qhSPDtGmHF8gypUOZ9s,1
97
97
  flwr/simulation/app.py,sha256=kYvgqQeQKOzOlQRNWdEYnf6FxmvoStfqYGhsjEghqDQ,7773
98
98
  flwr/simulation/ray_transport/__init__.py,sha256=eJ3pijYkI7XhbX2rLu6FBGTo8hZkFL8RSj4twhApOGw,727
99
99
  flwr/simulation/ray_transport/ray_client_proxy.py,sha256=yGY8p0TKxak-OH7zqFxd9oDe3TQ_cfAZEp0-JJYEnyg,5472
100
- flwr_nightly-1.5.0.dev20230421.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
101
- flwr_nightly-1.5.0.dev20230421.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
102
- flwr_nightly-1.5.0.dev20230421.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
103
- flwr_nightly-1.5.0.dev20230421.dist-info/METADATA,sha256=IRf0WGOlo-tB58do5XJCg5xL_lRTELM00i0lSprbOF8,12772
104
- flwr_nightly-1.5.0.dev20230421.dist-info/RECORD,,
100
+ flwr_nightly-1.5.0.dev20230427.dist-info/METADATA,sha256=gxT5DFaxnvbIfD7H6h-qo_lVpkp3drfDsDpmlurfh60,12772
101
+ flwr_nightly-1.5.0.dev20230427.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
102
+ flwr_nightly-1.5.0.dev20230427.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
103
+ flwr_nightly-1.5.0.dev20230427.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
104
+ flwr_nightly-1.5.0.dev20230427.dist-info/RECORD,,