README, links, formatting

sgrvinod · sgrvinod · commit b1f8a9965f7d · 2023-11-15T14:50:45.000-07:00
diff --git a/README.md b/README.md
diff --git a/chess_transformers/__init__.py b/chess_transformers/__init__.py
@@ -1 +1,8 @@
-__all__ = ["configs", "data", "train", "play", "transformers"]
+__all__ = [
+    "transformers",
+    "configs",
+    "data",
+    "train",
+    "eval",
+    "play",
+]
diff --git a/chess_transformers/configs/data/LE1222.py b/chess_transformers/configs/data/LE1222.py
@@ -11,7 +11,7 @@
 ###############################
 
 DATA_FOLDER = os.path.join(
-    os.environ["CT_DATA_FOLDER"], NAME
+    os.environ.get("CT_DATA_FOLDER"), NAME
 )  # folder containing all data files
 H5_FILE = NAME + ".h5"  # H5 file containing data
 MAX_MOVE_SEQUENCE_LENGTH = 10  # expected maximum length of move sequences
diff --git a/chess_transformers/configs/data/LE1222x.py b/chess_transformers/configs/data/LE1222x.py
@@ -11,7 +11,7 @@
 ###############################
 
 DATA_FOLDER = os.path.join(
-    os.environ["CT_DATA_FOLDER"], NAME
+    os.environ.get("CT_DATA_FOLDER"), NAME
 )  # folder containing all data files
 H5_FILE = NAME + ".h5"  # H5 file containing data
 MAX_MOVE_SEQUENCE_LENGTH = 10  # expected maximum length of move sequences
diff --git a/chess_transformers/configs/data/__init__.py b/chess_transformers/configs/data/__init__.py
@@ -1 +1 @@
-__all__ = ["LE1222", "LE1222x"]
+__all__ = ["LE1222", "LE1222x"]
diff --git a/chess_transformers/configs/models/CT-E-20.py b/chess_transformers/configs/models/CT-E-20.py
@@ -65,14 +65,18 @@
 USE_AMP = True  # use automatic mixed precision training?
 CRITERION = LabelSmoothedCE  # training criterion (loss)
 OPTIMIZER = torch.optim.Adam  # optimizer
-LOGS_DIR = os.path.join(os.environ["CT_LOGS_FOLDER"], NAME)  # logs folder
+LOGS_DIR = (
+    os.path.join(os.environ.get("CT_LOGS_FOLDER"), NAME)
+    if os.environ.get("CT_LOGS_FOLDER")
+    else None
+)  # logs folder
 
 ###############################
 ######### Checkpoints #########
 ###############################
 
 CHECKPOINT_FOLDER = os.path.join(
-    os.environ["CT_CHECKPOINTS_FOLDER"], NAME
+    os.environ.get("CT_CHECKPOINTS_FOLDER"), NAME
 )  # folder containing checkpoints
 TRAINING_CHECKPOINT = (
     NAME + ".pt"
@@ -91,10 +95,10 @@
 ########## Stockfish ##########
 ###############################
 
-STOCKFISH_PATH = os.environ["CT_STOCKFISH_PATH"]  # path to Stockfish engine
-FAIRY_STOCKFISH_PATH = os.environ[
+STOCKFISH_PATH = os.environ.get("CT_STOCKFISH_PATH")  # path to Stockfish engine
+FAIRY_STOCKFISH_PATH = os.environ.get(
     "CT_FAIRY_STOCKFISH_PATH"
-]  # path to Fairy Stockfish engine
+)  # path to Fairy Stockfish engine
 LICHESS_LEVELS = {
     1: {"SKILL": -9, "DEPTH": 5, "TIME_CONSTRAINT": 0.050},
     2: {"SKILL": -5, "DEPTH": 5, "TIME_CONSTRAINT": 0.100},
@@ -105,6 +109,8 @@
     7: {"SKILL": 16, "DEPTH": 13, "TIME_CONSTRAINT": 0.500},
     8: {"SKILL": 20, "DEPTH": 22, "TIME_CONSTRAINT": 1.000},
 }  # from https://github.com/lichess-org/fishnet/blob/dc4be23256e3e5591578f0901f98f5835a138d73/src/api.rs#L224
-EVAL_GAMES_FOLDER = os.path.join(
-    os.environ["CT_EVAL_GAMES_FOLDER"], NAME
+EVAL_GAMES_FOLDER = (
+    os.path.join(os.environ.get("CT_EVAL_GAMES_FOLDER"), NAME)
+    if os.environ.get("CT_EVAL_GAMES_FOLDER")
+    else None
 )  # folder where games against Stockfish are saved in PGN files
diff --git a/chess_transformers/configs/models/CT-ED-45.py b/chess_transformers/configs/models/CT-ED-45.py
@@ -65,14 +65,18 @@
 USE_AMP = True  # use automatic mixed precision training?
 CRITERION = LabelSmoothedCE  # training criterion (loss)
 OPTIMIZER = torch.optim.Adam  # optimizer
-LOGS_DIR = os.path.join(os.environ["CT_LOGS_FOLDER"], NAME)  # logs folder
+LOGS_DIR = (
+    os.path.join(os.environ.get("CT_LOGS_FOLDER"), NAME)
+    if os.environ.get("CT_LOGS_FOLDER")
+    else None
+)  # logs folder
 
 ###############################
 ######### Checkpoints #########
 ###############################
 
 CHECKPOINT_FOLDER = os.path.join(
-    os.environ["CT_CHECKPOINTS_FOLDER"], NAME
+    os.environ.get("CT_CHECKPOINTS_FOLDER"), NAME
 )  # folder containing checkpoints
 TRAINING_CHECKPOINT = (
     NAME + ".pt"
@@ -91,10 +95,10 @@
 ########## Stockfish ##########
 ###############################
 
-STOCKFISH_PATH = os.environ["CT_STOCKFISH_PATH"]  # path to Stockfish engine
-FAIRY_STOCKFISH_PATH = os.environ[
+STOCKFISH_PATH = os.environ.get("CT_STOCKFISH_PATH")  # path to Stockfish engine
+FAIRY_STOCKFISH_PATH = os.environ.get(
     "CT_FAIRY_STOCKFISH_PATH"
-]  # path to Fairy Stockfish engine
+)  # path to Fairy Stockfish engine
 LICHESS_LEVELS = {
     1: {"SKILL": -9, "DEPTH": 5, "TIME_CONSTRAINT": 0.050},
     2: {"SKILL": -5, "DEPTH": 5, "TIME_CONSTRAINT": 0.100},
@@ -105,6 +109,8 @@
     7: {"SKILL": 16, "DEPTH": 13, "TIME_CONSTRAINT": 0.500},
     8: {"SKILL": 20, "DEPTH": 22, "TIME_CONSTRAINT": 1.000},
 }  # from https://github.com/lichess-org/fishnet/blob/dc4be23256e3e5591578f0901f98f5835a138d73/src/api.rs#L224
-EVAL_GAMES_FOLDER = os.path.join(
-    os.environ["CT_EVAL_GAMES_FOLDER"], NAME
+EVAL_GAMES_FOLDER = (
+    os.path.join(os.environ.get("CT_EVAL_GAMES_FOLDER"), NAME)
+    if os.environ.get("CT_EVAL_GAMES_FOLDER")
+    else None
 )  # folder where games against Stockfish are saved in PGN files
diff --git a/chess_transformers/configs/models/__init__.py b/chess_transformers/configs/models/__init__.py
@@ -1 +1 @@
-__all__ = ["CT-E-19", "CT-ED-45"]
+__all__ = ["CT-E-19", "CT-ED-45"]
diff --git a/chess_transformers/data/__init__.py b/chess_transformers/data/__init__.py
@@ -1 +1,3 @@
-__all__ = ["prep"]
+__all__ = ["prep", "utils"]
+
+from chess_transformers.data.prep import prepare_data
diff --git a/chess_transformers/eval/__init__.py b/chess_transformers/eval/__init__.py
@@ -0,0 +1 @@
+__all__ = ["metrics"]
diff --git a/chess_transformers/play/__init__.py b/chess_transformers/play/__init__.py
@@ -1,3 +1,3 @@
-__all__ = ["moves", "matchups", "clocks", "exceptions", "utils"]
+__all__ = ["moves", "play", "clocks", "exceptions", "utils"]
 
 from chess_transformers.play.play import human_v_model, model_v_engine, model_v_model, warm_up
diff --git a/chess_transformers/play/moves.py b/chess_transformers/play/moves.py
@@ -1,8 +1,5 @@
-import os
-import json
 import chess
 import torch
-from datetime import date
 from IPython.display import clear_output, Markdown, display
 
 from chess_transformers.play.utils import (
diff --git a/chess_transformers/play/play.py b/chess_transformers/play/play.py
@@ -2,9 +2,9 @@
 from IPython.utils import io
 from IPython.display import display, Markdown, clear_output
 
-from chess_transformers.play.utils import get_pgn, in_notebook, print_text, print_board
 from chess_transformers.play.exceptions import OutOfTime
 from chess_transformers.play.moves import model_move, engine_move, human_move
+from chess_transformers.play.utils import get_pgn, in_notebook, print_text, print_board
 
 
 def model_v_engine(
diff --git a/chess_transformers/train/__init__.py b/chess_transformers/train/__init__.py
@@ -1 +1,3 @@
-__all__ = ["utils", "datasets"]
+__all__ = ["utils", "datasets", "average_checkpoints", "train"]
+
+from chess_transformers.train.train import train_model
diff --git a/img/ct_e_20.png b/img/ct_e_20.png
diff --git a/img/ct_ed_45.png b/img/ct_ed_45.png
diff --git a/img/logo.png b/img/logo.png
diff --git a/img/logo_old.png b/img/logo_old.png

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__all__ = ["LE1222", "LE1222x"]`
	`1`	`+__all__ = ["LE1222", "LE1222x"]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__all__ = ["CT-E-19", "CT-ED-45"]`
	`1`	`+__all__ = ["CT-E-19", "CT-ED-45"]`