Duplicate from aimstack/aim

Co-authored-by: Karen Hambardzumyan <mahnerak@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+aim_repo.tar.gz filter=lfs diff=lfs merge=lfs -text

Dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.9
+
+RUN useradd -m -u 1000 aim_user
+
+# Switch to the "aim_user" user
+USER aim_user
+
+# Set home to the user's home directory
+ENV HOME=/home/aim_user \
+	PATH=/home/aim_user/.local/bin:$PATH
+
+# Set the working directory to the user's home directory
+WORKDIR $HOME
+
+# install the `aim` package on the latest version
+RUN pip install aim
+
+RUN aim telemetry off
+
+ENTRYPOINT ["/bin/sh", "-c"]
+
+COPY aim_repo.tar.gz .
+RUN tar xvzf aim_repo.tar.gz
+# have to run `aim init` in the directory that stores aim data for
+# otherwise `aim up` will prompt for confirmation to create the directory itself.
+# We run aim listening on 0.0.0.0 to expose all ports. Also, we run
+# using `--dev` to print verbose logs. Port 43800 is the default port of
+# `aim up` but explicit is better than implicit.
+CMD ["aim up --host 0.0.0.0 --port 7860 --workers 2"]
+

README.md

@@ -0,0 +1,80 @@
+---
+title: Aim
+emoji: 🔥
+colorFrom: purple
+colorTo: blue
+sdk: docker
+license: other
+fullWidth: true
+---
+
+# Aim on Spaces
+
+**Hugging Face Spaces** offer a simple way to host ML demo apps directly on your profile or your organization’s profile. This allows you to create your ML portfolio, showcase your projects at conferences or to stakeholders, and work collaboratively with other people in the ML ecosystem.
+Hugging Face Spaces make it easy for you to create and deploy ML-powered demos in minutes.
+
+Check out the [Hugging Face Spaces docs](https://huggingface.co/docs/hub/spaces-overview) to learn more about Spaces.
+
+## Deploy Aim on Spaces
+
+You can deploy Aim on Spaces with a single click!
+
+<a href="https://huggingface.co/new-space?template=aimstack/aim">
+    <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-lg.svg" />
+</a>
+
+Once you have created the Space, you'll see the `Building` status, and once it becomes `Running,` your Space is ready to go!
+
+<img src="https://user-images.githubusercontent.com/23078323/231592155-869148a0-9a92-475f-8ebe-34d4deb2abc2.png" alt="Creating an Aim Space" width=800 />
+
+Now, when you navigate to your Space's **App** section, you can access the Aim UI.
+
+## Compare your experiments with Aim on Spaces
+
+Let's use a quick example of a PyTorch CNN trained on MNIST to demonstrate end-to-end Aim on Spaces deployment.
+The full example is in the [Aim repo examples folder](https://github.com/aimhubio/aim/blob/main/examples/pytorch_track.py).
+
+```python
+from aim import Run
+from aim.pytorch import track_gradients_dists, track_params_dists
+
+# Initialize a new Run
+aim_run = Run()
+...
+items = {'accuracy': acc, 'loss': loss}
+aim_run.track(items, epoch=epoch, context={'subset': 'train'})
+
+# Track weights and gradients distributions
+track_params_dists(model, aim_run)
+track_gradients_dists(model, aim_run)
+```
+
+The experiments tracked by Aim are stored in the `.aim` folder. **To display the logs with the Aim UI in your Space, you need to compress the `.aim` folder to a `tar.gz` file and upload it to your Space using `git` or the Files and Versions sections of your Space.**
+
+Here's a bash command for that:
+
+```bash
+tar -czvf aim_repo.tar.gz .aim
+```
+
+That’s it! Now open the App section of your Space and the Aim UI is available with your logs.
+Here is what to expect:
+
+![Aim UI on HF Hub Spaces](https://user-images.githubusercontent.com/23078323/232034340-0ba3ebbf-0374-4b14-ba80-1d36162fc994.png)
+
+Filter your runs using Aim’s Pythonic search. You can write pythonic [queries against](https://aimstack.readthedocs.io/en/latest/using/search.html) EVERYTHING you have tracked - metrics, hyperparams etc. Check out some [examples](https://huggingface.co/aimstack) on HF Hub Spaces.
+
+<Tip>
+Note that if your logs are in TensorBoard format, you can easily convert <a href="https://aimstack.readthedocs.io/en/latest/quick_start/convert_data.html#show-tensorboard-logs-in-aim">them to Aim with one command</a> and use the many advanced and high-performant training run comparison features available.
+</Tip>
+
+## More on HF Spaces
+
+- [HF Docker spaces](https://github.com/huggingface/hub-docs/blob/main/docs/hub/spaces-sdks-docker.md)
+- [HF Docker space examples](https://github.com/huggingface/hub-docs/blob/main/docs/hub/spaces-sdks-docker.md)
+
+## Feedback and Support
+
+If you have improvement suggestions or need support, please open an issue on [Aim GitHub repo](https://github.com/aimhubio/aim).
+
+The [Aim community Discord](https://github.com/aimhubio/aim#-community) is also available for community discussions.

aim_repo.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ad85d625c781762b8f127a84d456a8d2f8ae602b37a8ef1dbe4b5dd64c9cff54
+size 1369