From 93b906b3fb4179a6476b118bd80218c34f272a46 Mon Sep 17 00:00:00 2001
From: OleehyO <leehy0357@gmail.com>
Date: Sat, 4 Jan 2025 06:20:25 +0000
Subject: [PATCH] docs: clarify train_frames includes padding frame

Add docstring to train_frames field in State schema to explicitly indicate
that it includes one image padding frame
---
 finetune/schemas/state.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/finetune/schemas/state.py b/finetune/schemas/state.py
index 9d5363c..9ad24f0 100644
--- a/finetune/schemas/state.py
+++ b/finetune/schemas/state.py
@@ -7,7 +7,7 @@ from pydantic import BaseModel, field_validator
 class State(BaseModel):
     model_config = {"arbitrary_types_allowed": True}
 
-    train_frames: int
+    train_frames: int  # user-defined training frames, **containing one image padding frame**
     train_height: int
     train_width: int