From 954b7ff4ac031c1ffaf9fed10465d75b9ecafed0 Mon Sep 17 00:00:00 2001 From: Rajat Sen Date: Tue, 9 Jul 2024 17:13:51 +0000 Subject: [PATCH] adding formatting instructions to README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f4f18e..b252802 100644 --- a/README.md +++ b/README.md @@ -164,4 +164,19 @@ forecast_df = tfm.forecast_on_df( ## Finetuning -We have provided an example of finetuning the model on a new dataset in `notebooks/finetuning.ipynb`. \ No newline at end of file +We have provided an example of finetuning the model on a new dataset in `notebooks/finetuning.ipynb`. + +## Contribution Style guide + +If you would like to submit a PR please make sure that you use our formatting style. We use [yapf](https://github.com/google/yapf) for formatting with the following options, + +``` +[style] +based_on_style = google +# Add your custom style rules here +indent_width = 2 +spaces_before_comment = 2 + +``` + +Please run `yapf --in-place --recursive ` on all affected files. \ No newline at end of file