Documentation for training using torchtitan

[MaxiBoether]

No description provided.

[github-actions]

✅ Result of Pytest Coverage

---------- coverage: platform linux, python 3.10.0-final-0 -----------

Name	Stmts	Miss	Cover
mixtera/core/algo/ado/ado.py	375	171	54%
mixtera/core/algo/dynamic_mixing/dynamic_mixing.py	32	3	91%
mixtera/core/client/local/local_stub.py	110	19	83%
mixtera/core/client/mixtera_client.py	127	30	76%
mixtera/core/client/server/server_stub.py	79	19	76%
mixtera/core/datacollection/datasets/croissant_dataset.py	16	3	81%
mixtera/core/datacollection/datasets/dataset.py	38	14	63%
mixtera/core/datacollection/datasets/dataset_type.py	7	0	100%
mixtera/core/datacollection/datasets/jsonl_dataset.py	58	9	84%
mixtera/core/datacollection/datasets/parquet_dataset.py	83	5	94%
mixtera/core/datacollection/datasets/web_dataset.py	39	7	82%
mixtera/core/datacollection/index/index.py	6	1	83%
mixtera/core/datacollection/index/index_collection.py	11	0	100%
mixtera/core/datacollection/index/index_utils.py	14	0	100%
mixtera/core/datacollection/index/parser/metadata_parser.py	51	7	86%
mixtera/core/datacollection/index/parser/parser_collection.py	80	18	78%
mixtera/core/datacollection/mixtera_data_collection.py	369	119	68%
mixtera/core/datacollection/property.py	7	0	100%
mixtera/core/datacollection/property_type.py	4	0	100%
mixtera/core/filesystem/filesystem.py	37	1	97%
mixtera/core/filesystem/local_filesystem.py	26	0	100%
mixtera/core/processing/execution_mode.py	4	0	100%
mixtera/core/processing/property_calculation/executor.py	22	2	91%
mixtera/core/processing/property_calculation/local_executor.py	68	14	79%
mixtera/core/query/chunk_distributor.py	248	171	31%
mixtera/core/query/mixture/arbitrary_mixture.py	12	1	92%
mixtera/core/query/mixture/dynamic_mixture.py	52	3	94%
mixtera/core/query/mixture/hierarchical_static_mixture.py	44	5	89%
mixtera/core/query/mixture/inferring_mixture.py	28	6	79%
mixtera/core/query/mixture/mixture.py	34	8	76%
mixtera/core/query/mixture/mixture_key.py	48	3	94%
mixtera/core/query/mixture/mixture_schedule.py	34	9	74%
mixtera/core/query/mixture/static_mixture.py	42	10	76%
mixtera/core/query/operators/_base.py	23	1	96%
mixtera/core/query/operators/select.py	107	3	97%
mixtera/core/query/query.py	54	0	100%
mixtera/core/query/query_cache.py	76	9	88%
mixtera/core/query/query_plan.py	18	2	89%
mixtera/core/query/query_result.py	378	91	76%
mixtera/core/query/result_chunk.py	296	114	61%
mixtera/hf/mixtera_hf_dataset.py	75	47	37%
mixtera/network/client/client_feedback.py	8	0	100%
mixtera/network/connection/server_connection.py	251	49	80%
mixtera/network/network_utils.py	90	10	89%
mixtera/network/server/entrypoint.py	22	22	0%
mixtera/network/server/server.py	280	135	52%
mixtera/network/server_task.py	19	0	100%
mixtera/tests/core/algo/ado/test_ado.py	167	0	100%
mixtera/tests/core/client/local/test_local_stub.py	198	1	99%
mixtera/tests/core/client/server/test_server_stub.py	147	0	100%
mixtera/tests/core/client/test_mixtera_client.py	66	0	100%
mixtera/tests/core/datacollection/datasets/test_dataset.py	0	0	100%
mixtera/tests/core/datacollection/datasets/test_jsonl_dataset.py	67	6	91%
mixtera/tests/core/datacollection/datasets/test_parquet_dataset.py	163	5	97%
mixtera/tests/core/datacollection/datasets/test_web_dataset.py	49	0	100%
mixtera/tests/core/datacollection/index/parser/test_parser_collection.py	81	2	98%
mixtera/tests/core/datacollection/index/test_index_utils.py	15	1	93%
mixtera/tests/core/datacollection/test_mixtera_data_collection.py	249	5	98%
mixtera/tests/core/datacollection/test_property_type.py	7	0	100%
mixtera/tests/core/filesystem/test_filesystem.py	47	0	100%
mixtera/tests/core/filesystem/test_local_filesystem.py	39	0	100%
mixtera/tests/core/processing/property_calculation/test_executor.py	22	0	100%
mixtera/tests/core/processing/property_calculation/test_local_executor.py	51	0	100%
mixtera/tests/core/processing/test_execution_mode.py	7	0	100%
mixtera/tests/core/query/operators/test_base.py	45	1	98%
mixtera/tests/core/query/operators/test_select.py	162	1	99%
mixtera/tests/core/query/test_chunk_distributor.py	113	1	99%
mixtera/tests/core/query/test_dynamic_mixture.py	120	0	100%
mixtera/tests/core/query/test_e2e.py	60	3	95%
mixtera/tests/core/query/test_mixture.py	20	1	95%
mixtera/tests/core/query/test_mixture_schedule.py	15	1	93%
mixtera/tests/core/query/test_query.py	143	4	97%
mixtera/tests/core/query/test_query_cache.py	85	4	95%
mixtera/tests/core/query/test_query_result.py	302	0	100%
mixtera/tests/core/query/test_result_chunk.py	195	1	99%
mixtera/tests/network/connection/test_server_connection.py	379	1	99%
mixtera/tests/network/server/test_server.py	179	0	100%
mixtera/tests/network/test_network_utils.py	165	1	99%
mixtera/tests/network/test_server_task.py	51	0	100%
mixtera/tests/utils/test_checkpoint.py	60	0	100%
mixtera/tests/utils/test_tokenizing_iterator.py	237	1	99%
mixtera/tests/utils/test_utils.py	95	1	99%
mixtera/torch/mixtera_torch_dataset.py	176	133	24%
mixtera/utils/checkpoint.py	22	0	100%
mixtera/utils/dataset_utils.py	104	82	21%
mixtera/utils/feedback.py	20	20	0%
mixtera/utils/prefetch_iterator.py	25	18	28%
mixtera/utils/tokenizing_iterator.py	136	7	95%
mixtera/utils/utils.py	232	76	67%
mixtera/utils/webdataset_utils.py	80	24	70%
TOTAL	8498	1542	82%
Coverage	HTML	written	to
==================	323	passed,	1