From 3a40bc6beaed5bf709733fc7fa7937d2f19ce93d Mon Sep 17 00:00:00 2001 From: Dmitrii Emelianenko Date: Mon, 16 Dec 2024 18:44:41 +0100 Subject: [PATCH] Add poolside-specific README (#1) * Add poolside-specific README and a change list --- README.md | 5 +++++ poolside-changes.md | 2 ++ poolside.md | 27 +++++++++++++++++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 poolside-changes.md create mode 100644 poolside.md diff --git a/README.md b/README.md index e9d9d8bcd622b..ec98347fee45e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +This is a poolside-specific fork of pytorch. For now we do not have any custom code, only some changes to CI/build workflows. +See [poolside.md](poolside.md) for more info about this fork. + +-------------------------------------------------------------------------------- + ![PyTorch Logo](https://github.com/pytorch/pytorch/raw/main/docs/source/_static/img/pytorch-logo-dark.png) -------------------------------------------------------------------------------- diff --git a/poolside-changes.md b/poolside-changes.md new file mode 100644 index 0000000000000..54180ab121e12 --- /dev/null +++ b/poolside-changes.md @@ -0,0 +1,2 @@ +# poolside changes compared to upstream: +* [16th Dec 2024] Added READMEs describing this fork. [PR](https://github.com/poolsideai/pytorch/pull/1). diff --git a/poolside.md b/poolside.md new file mode 100644 index 0000000000000..15e15165efdbf --- /dev/null +++ b/poolside.md @@ -0,0 +1,27 @@ +# poolside's fork of pytorch + +Why this fork? +* We might need to fix problems with pytorch that block or slowdown training of our models. +* We don't want to wait until such problems are fixed in the upstream. +* We need custom build configurations anyway. + +With that said, we don't want to maintain a completely separate version of pytorch. + +To avoid this, we try to follow these principles: +* Updating to the current upstream should not be problematic and we should do it often. +* If we commit any changes: + * We should minimize potential breaking changes/conflicts with the upstream. + * If the risk for potential conflicts is significant, we should consider commiting the changes to the upstream. + +## Repository organisation: +Right now we have two branches: +* `main` -- follows the `main` branch of the upstream +* `poolside-main` -- contains our changes and should be rebased over `main` + +We commit our changes to `poolside-main`. +If we want to commit our changes to the upstream, we branch from `main` and cherry-pick the corresponding commits from `poolside-main`. + +The changes we made should be summarized in the [poolside-changes.md](poolside-changes.md) file. + +Feel free to contact Dmitrii Emelianenko or Vadim Markovtsev for any questions regarding this repo. +