Skip to content

Commit

Permalink
Add poolside-specific README (#1)
Browse files Browse the repository at this point in the history
* Add poolside-specific README and a change list
  • Loading branch information
dimdi-y committed Dec 18, 2024
1 parent 5d3bc63 commit 3a40bc6
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

--------------------------------------------------------------------------------
Expand Down
2 changes: 2 additions & 0 deletions poolside-changes.md
Original file line number Diff line number Diff line change
@@ -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).
27 changes: 27 additions & 0 deletions poolside.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3a40bc6

Please sign in to comment.