Merge branch 'main' into update-tensorflow-example-flrw-run

src/py/flwr/cli/new/new.py

@@ -135,7 +135,7 @@ def new(
  username = prompt_text("Please provide your Flower username")
 
  if framework is not None:
- framework_str = str(framework.value)
+ framework_str_upper = str(framework.value)
  else:
  framework_value = prompt_options(
  "Please select ML framework by typing in the number",
@@ -146,9 +146,9 @@ def new(
  for name, value in vars(MlFramework).items()
  if value == framework_value
  ]
- framework_str = selected_value[0]
+ framework_str_upper = selected_value[0]
 
- framework_str = framework_str.lower()
+ framework_str = framework_str_upper.lower()
 
  llm_challenge_str = None
  if framework_str == "flowertune":
@@ -173,9 +173,10 @@ def new(
  )
 
  context = {
- "project_name": project_name,
- "package_name": package_name,
+ "framework_str": framework_str_upper,
  "import_name": import_name.replace("-", "_"),
+ "package_name": package_name,
+ "project_name": project_name,
  "username": username,
  }
 

src/py/flwr/cli/new/new_test.py

@@ -39,6 +39,7 @@ def test_render_template() -> None:
  # Prepare
  filename = "app/README.md.tpl"
  data = {
+ "framework_str": "",
  "project_name": "FedGPT",
  "package_name": "fedgpt",
  "import_name": "fedgpt",

src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -1,4 +1,4 @@
-# $project_name
+# $project_name: A Flower / $framework_str app
 
 ## Install dependencies
 

src/py/flwr/cli/new/templates/app/code/__init__.py.tpl

@@ -1 +1 @@
-"""$project_name."""
+"""$project_name: A Flower / $framework_str app."""

src/py/flwr/cli/new/templates/app/code/client.huggingface.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / HuggingFace Transformers app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.client import ClientApp, NumPyClient
 from flwr.common import Context

src/py/flwr/cli/new/templates/app/code/client.jax.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / JAX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import jax
 from flwr.client import NumPyClient, ClientApp

src/py/flwr/cli/new/templates/app/code/client.mlx.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / MLX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import mlx.core as mx
 import mlx.nn as nn

src/py/flwr/cli/new/templates/app/code/client.numpy.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / NumPy app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.client import NumPyClient, ClientApp
 from flwr.common import Context

src/py/flwr/cli/new/templates/app/code/client.pytorch.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / PyTorch app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.client import NumPyClient, ClientApp
 from flwr.common import Context

src/py/flwr/cli/new/templates/app/code/client.sklearn.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / Scikit-Learn app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import warnings
 

src/py/flwr/cli/new/templates/app/code/client.tensorflow.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / TensorFlow app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.client import NumPyClient, ClientApp
 from flwr.common import Context

src/py/flwr/cli/new/templates/app/code/server.huggingface.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / HuggingFace Transformers app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context
 from flwr.server.strategy import FedAvg

src/py/flwr/cli/new/templates/app/code/server.jax.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / JAX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context
 from flwr.server.strategy import FedAvg

src/py/flwr/cli/new/templates/app/code/server.mlx.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / MLX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig

src/py/flwr/cli/new/templates/app/code/server.numpy.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / NumPy app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig

src/py/flwr/cli/new/templates/app/code/server.pytorch.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / PyTorch app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context, ndarrays_to_parameters
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig

src/py/flwr/cli/new/templates/app/code/server.sklearn.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / Scikit-Learn app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig

src/py/flwr/cli/new/templates/app/code/server.tensorflow.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / TensorFlow app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from flwr.common import Context, ndarrays_to_parameters
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig

src/py/flwr/cli/new/templates/app/code/task.huggingface.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / HuggingFace Transformers app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import warnings
 from collections import OrderedDict

src/py/flwr/cli/new/templates/app/code/task.jax.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / JAX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import jax
 import jax.numpy as jnp

src/py/flwr/cli/new/templates/app/code/task.mlx.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / MLX app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import mlx.core as mx
 import mlx.nn as nn

src/py/flwr/cli/new/templates/app/code/task.pytorch.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / PyTorch app."""
+"""$project_name: A Flower / $framework_str app."""
 
 from collections import OrderedDict
 

src/py/flwr/cli/new/templates/app/code/task.tensorflow.py.tpl

@@ -1,4 +1,4 @@
-"""$project_name: A Flower / TensorFlow app."""
+"""$project_name: A Flower / $framework_str app."""
 
 import os