Skip to content
machinable404
PAGE NOT FOUND
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
from typing import List, Optional
+# your codefrom typing import List, Optional
import os
diff --git a/assets/examples_aimstack-storage_index.md.6eacb297.lean.js b/assets/examples_aimstack-storage_index.md.c3418677.lean.js
similarity index 100%
rename from assets/examples_aimstack-storage_index.md.6eacb297.lean.js
rename to assets/examples_aimstack-storage_index.md.c3418677.lean.js
diff --git a/assets/examples_globus-storage_index.md.f1237033.js b/assets/examples_globus-storage_index.md.a8bc1101.js
similarity index 99%
rename from assets/examples_globus-storage_index.md.f1237033.js
rename to assets/examples_globus-storage_index.md.a8bc1101.js
index ccc3b92e..09876b0a 100644
--- a/assets/examples_globus-storage_index.md.f1237033.js
+++ b/assets/examples_globus-storage_index.md.a8bc1101.js
@@ -13,7 +13,7 @@ import{_ as s,o as n,c as a,O as l}from"./chunks/framework.62020867.js";const i=
print(matches)
# download from globus
-storage.download(matches[0].uuid)from typing import TYPE_CHECKING, List
+storage.download(matches[0].uuid)from typing import TYPE_CHECKING, List
import os
import time
diff --git a/assets/examples_globus-storage_index.md.f1237033.lean.js b/assets/examples_globus-storage_index.md.a8bc1101.lean.js
similarity index 100%
rename from assets/examples_globus-storage_index.md.f1237033.lean.js
rename to assets/examples_globus-storage_index.md.a8bc1101.lean.js
diff --git a/assets/examples_mpi-execution_index.md.bf53f2d6.js b/assets/examples_mpi-execution_index.md.9dd8e138.js
similarity index 99%
rename from assets/examples_mpi-execution_index.md.bf53f2d6.js
rename to assets/examples_mpi-execution_index.md.9dd8e138.js
index 70514ec1..669a3e0b 100644
--- a/assets/examples_mpi-execution_index.md.bf53f2d6.js
+++ b/assets/examples_mpi-execution_index.md.9dd8e138.js
@@ -1,7 +1,7 @@
import{_ as s,o as n,c as a,O as l}from"./chunks/framework.62020867.js";const i=JSON.parse('{"title":"MPI execution","description":"","frontmatter":{},"headers":[],"relativePath":"examples/mpi-execution/index.md","filePath":"examples/mpi-execution/index.md"}'),p={name:"examples/mpi-execution/index.md"},o=l(`MPI execution
Integration to launch MPI jobs.
Usage example
pythonfrom machinable import get
with get("mpi", {"ranks": 8}):
- ... # your MPI ready component
Source
pyfrom typing import Literal, Optional, Union
+ ... # your MPI ready component
Source
pyfrom typing import Literal, Optional, Union
import sys
diff --git a/assets/examples_mpi-execution_index.md.bf53f2d6.lean.js b/assets/examples_mpi-execution_index.md.9dd8e138.lean.js
similarity index 100%
rename from assets/examples_mpi-execution_index.md.bf53f2d6.lean.js
rename to assets/examples_mpi-execution_index.md.9dd8e138.lean.js
diff --git a/assets/examples_require-execution_index.md.08f79fdd.js b/assets/examples_require-execution_index.md.5e46839f.js
similarity index 98%
rename from assets/examples_require-execution_index.md.08f79fdd.js
rename to assets/examples_require-execution_index.md.5e46839f.js
index 260f0fff..011d7612 100644
--- a/assets/examples_require-execution_index.md.08f79fdd.js
+++ b/assets/examples_require-execution_index.md.5e46839f.js
@@ -1,7 +1,7 @@
import{_ as s,o as a,c as n,O as l}from"./chunks/framework.62020867.js";const C=JSON.parse('{"title":"Require execution","description":"","frontmatter":{},"headers":[],"relativePath":"examples/require-execution/index.md","filePath":"examples/require-execution/index.md"}'),p={name:"examples/require-execution/index.md"},o=l(`Require execution
A way to assert that components have been cached.
Usage example
pythonfrom machinable import get
with get("require"):
- ... # components to check
Source
pyfrom machinable import Execution
+ ... # components to check
Source
pyfrom machinable import Execution
class Require(Execution):
diff --git a/assets/examples_require-execution_index.md.08f79fdd.lean.js b/assets/examples_require-execution_index.md.5e46839f.lean.js
similarity index 100%
rename from assets/examples_require-execution_index.md.08f79fdd.lean.js
rename to assets/examples_require-execution_index.md.5e46839f.lean.js
diff --git a/assets/examples_slurm-execution_index.md.939e1383.js b/assets/examples_slurm-execution_index.md.68c750f8.js
similarity index 99%
rename from assets/examples_slurm-execution_index.md.939e1383.js
rename to assets/examples_slurm-execution_index.md.68c750f8.js
index 12102874..f616bfee 100644
--- a/assets/examples_slurm-execution_index.md.939e1383.js
+++ b/assets/examples_slurm-execution_index.md.68c750f8.js
@@ -1,7 +1,7 @@
import{_ as s,o as n,c as a,O as l}from"./chunks/framework.62020867.js";const i=JSON.parse('{"title":"Slurm execution","description":"","frontmatter":{},"headers":[],"relativePath":"examples/slurm-execution/index.md","filePath":"examples/slurm-execution/index.md"}'),o={name:"examples/slurm-execution/index.md"},p=l(`Slurm execution
Integration to submit to the Slurm scheduler.
Usage example
pythonfrom machinable import get
with get("slurm", {"ranks": 8, 'preamble': 'mpirun'}):
- ... # your component
Source
pyfrom typing import Literal, Optional, Union
+ ... # your component
Source
pyfrom typing import Literal, Optional, Union
import os
import subprocess
diff --git a/assets/examples_slurm-execution_index.md.939e1383.lean.js b/assets/examples_slurm-execution_index.md.68c750f8.lean.js
similarity index 100%
rename from assets/examples_slurm-execution_index.md.939e1383.lean.js
rename to assets/examples_slurm-execution_index.md.68c750f8.lean.js
diff --git a/assets/guide_component.md.eef0762f.js b/assets/guide_component.md.d7585b40.js
similarity index 99%
rename from assets/guide_component.md.eef0762f.js
rename to assets/guide_component.md.d7585b40.js
index b29f4493..b4ac01fa 100644
--- a/assets/guide_component.md.eef0762f.js
+++ b/assets/guide_component.md.d7585b40.js
@@ -17,7 +17,7 @@ import{_ as p,D as t,o as c,c as r,z as n,a as s,G as o,B as l,O as e}from"./chu
>>> mnist.launch()
Downloading 'mnist' ...
If the execution is successful, the component is marked as finished.
python>>> mnist.execution.is_finished()
True
By design, component instances can only be executed once. They are automatically assigned a timestamp, random seed, as well as a nickname for easy identification.
python>>> mnist.seed
-1632827863
Invocations of launch() after successful execution, do not trigger another execution since the component is marked as cached. On the other hand, if the execution failed, calling launch() will resume the execution with the same configuration.
Implementing custom execution
Components can be executed in different ways. You may, for example, like to run components using multiprocessing or execute in a cloud environment. However, instead of adding the execution logic directly to your component code, machinable makes it easy to separate concerns. You can encapsulate the execution implementation in its own execution class that can then be used to execute the component.
`,8),C=e(`pythonfrom multiprocessing import Pool
+1632827863
Invocations of launch() after successful execution, do not trigger another execution since the component is marked as cached. On the other hand, if the execution failed, calling launch() will resume the execution with the same configuration.
Implementing custom execution
Components can be executed in different ways. You may, for example, like to run components using multiprocessing or execute in a cloud environment. However, instead of adding the execution logic directly to your component code, machinable makes it easy to separate concerns. You can encapsulate the execution implementation in its own execution class that can then be used to execute the component.
`,8),C=e(`pythonfrom multiprocessing import Pool
from machinable import Execution
diff --git a/assets/guide_component.md.eef0762f.lean.js b/assets/guide_component.md.d7585b40.lean.js
similarity index 100%
rename from assets/guide_component.md.eef0762f.lean.js
rename to assets/guide_component.md.d7585b40.lean.js
diff --git a/assets/guide_interface.md.8d3c5449.js b/assets/guide_interface.md.03f9e498.js
similarity index 98%
rename from assets/guide_interface.md.8d3c5449.js
rename to assets/guide_interface.md.03f9e498.js
index 644173c1..50e13bfc 100644
--- a/assets/guide_interface.md.8d3c5449.js
+++ b/assets/guide_interface.md.03f9e498.js
@@ -21,7 +21,7 @@ import{_ as t,D as p,o as c,c as r,z as a,a as s,G as l,B as o,O as e}from"./chu
├─ estimate_gravity.py # contains a data analysis component
├─ evolution/
| └─ simulate_offspring.py # contains a evolutionary simulation
-└─ main.py # main script to execute
The benefit of this requirement is that you can refer to the classes via their module import path. For example, using this module convention, you can simplify the instantiation of classes that are located in different modules:
pythonfrom machinable import get
+└─ main.py # main script to execute
The benefit of this requirement is that you can refer to the classes via their module import path. For example, using this module convention, you can simplify the instantiation of classes that are located in different modules:
pythonfrom machinable import get
from estimate_gravity import EstimateGravity
from evolution.simulate_offspring import SimulateOffspring
@@ -40,4 +40,4 @@ import{_ as t,D as p,o as c,c as r,z as a,a as s,G as l,B as o,O as e}from"./chu
mnist = get("mnist_data")
with open(mnist.local_directory("download_script.sh"), "w") as f:
f.write(...)
- os.chmod(f.name, 0o755)
Overall, interfaces make it easy to associate data with code as instantiation, storage and retrieval are managed automatically behind the scenes.
`,2);function _(b,v,E,q,T,w){const n=p("Pydoc");return c(),r("div",null,[y,D,a("p",null,[s("To enable storage and retrival we can use an "),l(n,null,{default:o(()=>[s("machinable.Interface")]),_:1}),s(" class.")]),F,a("p",null,[s("Specifically, to instantiate an interface (e.g. "),A,s(") we can leverage the "),l(n,null,{default:o(()=>[s("machinable.get")]),_:1}),s(" function, which takes a class as the first argument and optional constructor arguments.")]),d,a("p",null,[s("What is happening here is that "),l(n,{caption:"get()"},{default:o(()=>[s("machinable.get")]),_:1}),s(" automatically searches the storage for an interface of type "),C,s(" with a "),u,s(" of "),h,s(". If such an instance has not been committed yet (like when initially running the code), a new instance with this configuration will be returned. But if such an instance has previously been committed, it will simply be reloaded.")]),m,a("p",null,[s("While machinable automatically commits crucial information about the interface, you can use "),l(n,null,{default:o(()=>[s("machinable.Interface.save_file")]),_:1}),s(" and "),l(n,null,{default:o(()=>[s("machinable.Interface.load_file")]),_:1}),s(" to easily store and retrieve additional custom data in different file formats:")]),f,a("p",null,[s("This may be useful to save and restore some custom state of the interface. Furthermore, you are free to implement your own methods to persist data by writing and reading from the interface's "),l(n,{caption:"local_directory()"},{default:o(()=>[s("machinable.Interface.local_directory")]),_:1}),s(":")]),g])}const S=t(i,[["render",_]]);export{k as __pageData,S as default};
+ os.chmod(f.name, 0o755)Overall, interfaces make it easy to associate data with code as instantiation, storage and retrieval are managed automatically behind the scenes.
`,2);function _(b,v,q,E,T,w){const n=p("Pydoc");return c(),r("div",null,[y,D,a("p",null,[s("To enable storage and retrival we can use an "),l(n,null,{default:o(()=>[s("machinable.Interface")]),_:1}),s(" class.")]),F,a("p",null,[s("Specifically, to instantiate an interface (e.g. "),A,s(") we can leverage the "),l(n,null,{default:o(()=>[s("machinable.get")]),_:1}),s(" function, which takes a class as the first argument and optional constructor arguments.")]),d,a("p",null,[s("What is happening here is that "),l(n,{caption:"get()"},{default:o(()=>[s("machinable.get")]),_:1}),s(" automatically searches the storage for an interface of type "),C,s(" with a "),u,s(" of "),h,s(". If such an instance has not been committed yet (like when initially running the code), a new instance with this configuration will be returned. But if such an instance has previously been committed, it will simply be reloaded.")]),m,a("p",null,[s("While machinable automatically commits crucial information about the interface, you can use "),l(n,null,{default:o(()=>[s("machinable.Interface.save_file")]),_:1}),s(" and "),l(n,null,{default:o(()=>[s("machinable.Interface.load_file")]),_:1}),s(" to easily store and retrieve additional custom data in different file formats:")]),f,a("p",null,[s("This may be useful to save and restore some custom state of the interface. Furthermore, you are free to implement your own methods to persist data by writing and reading from the interface's "),l(n,{caption:"local_directory()"},{default:o(()=>[s("machinable.Interface.local_directory")]),_:1}),s(":")]),g])}const S=t(i,[["render",_]]);export{k as __pageData,S as default};
diff --git a/assets/guide_interface.md.8d3c5449.lean.js b/assets/guide_interface.md.03f9e498.lean.js
similarity index 97%
rename from assets/guide_interface.md.8d3c5449.lean.js
rename to assets/guide_interface.md.03f9e498.lean.js
index 48e28fb1..715e6835 100644
--- a/assets/guide_interface.md.8d3c5449.lean.js
+++ b/assets/guide_interface.md.03f9e498.lean.js
@@ -1 +1 @@
-import{_ as t,D as p,o as c,c as r,z as a,a as s,G as l,B as o,O as e}from"./chunks/framework.62020867.js";const k=JSON.parse('{"title":"Interface","description":"","frontmatter":{},"headers":[],"relativePath":"guide/interface.md","filePath":"guide/interface.md"}'),i={name:"guide/interface.md"},y=a("h1",{id:"interface",tabindex:"-1"},[s("Interface "),a("a",{class:"header-anchor",href:"#interface","aria-label":'Permalink to "Interface"'},"")],-1),D=a("p",null,[a("a",{href:"./element.html"},"Elements"),s(" by themselves are limited in that they are effectively stateless. You can construct and use them but any computed result or additional information will not be persisted.")],-1),F=e("",6),A=a("code",null,"MnistData()",-1),d=e("",3),C=a("code",null,"MnistData",-1),u=a("code",null,"batch_size",-1),h=a("code",null,"8",-1),m=e("",7),f=e("",1),g=e("",2);function _(b,v,E,q,T,w){const n=p("Pydoc");return c(),r("div",null,[y,D,a("p",null,[s("To enable storage and retrival we can use an "),l(n,null,{default:o(()=>[s("machinable.Interface")]),_:1}),s(" class.")]),F,a("p",null,[s("Specifically, to instantiate an interface (e.g. "),A,s(") we can leverage the "),l(n,null,{default:o(()=>[s("machinable.get")]),_:1}),s(" function, which takes a class as the first argument and optional constructor arguments.")]),d,a("p",null,[s("What is happening here is that "),l(n,{caption:"get()"},{default:o(()=>[s("machinable.get")]),_:1}),s(" automatically searches the storage for an interface of type "),C,s(" with a "),u,s(" of "),h,s(". If such an instance has not been committed yet (like when initially running the code), a new instance with this configuration will be returned. But if such an instance has previously been committed, it will simply be reloaded.")]),m,a("p",null,[s("While machinable automatically commits crucial information about the interface, you can use "),l(n,null,{default:o(()=>[s("machinable.Interface.save_file")]),_:1}),s(" and "),l(n,null,{default:o(()=>[s("machinable.Interface.load_file")]),_:1}),s(" to easily store and retrieve additional custom data in different file formats:")]),f,a("p",null,[s("This may be useful to save and restore some custom state of the interface. Furthermore, you are free to implement your own methods to persist data by writing and reading from the interface's "),l(n,{caption:"local_directory()"},{default:o(()=>[s("machinable.Interface.local_directory")]),_:1}),s(":")]),g])}const S=t(i,[["render",_]]);export{k as __pageData,S as default};
+import{_ as t,D as p,o as c,c as r,z as a,a as s,G as l,B as o,O as e}from"./chunks/framework.62020867.js";const k=JSON.parse('{"title":"Interface","description":"","frontmatter":{},"headers":[],"relativePath":"guide/interface.md","filePath":"guide/interface.md"}'),i={name:"guide/interface.md"},y=a("h1",{id:"interface",tabindex:"-1"},[s("Interface "),a("a",{class:"header-anchor",href:"#interface","aria-label":'Permalink to "Interface"'},"")],-1),D=a("p",null,[a("a",{href:"./element.html"},"Elements"),s(" by themselves are limited in that they are effectively stateless. You can construct and use them but any computed result or additional information will not be persisted.")],-1),F=e("",6),A=a("code",null,"MnistData()",-1),d=e("",3),C=a("code",null,"MnistData",-1),u=a("code",null,"batch_size",-1),h=a("code",null,"8",-1),m=e("",7),f=e("",1),g=e("",2);function _(b,v,q,E,T,w){const n=p("Pydoc");return c(),r("div",null,[y,D,a("p",null,[s("To enable storage and retrival we can use an "),l(n,null,{default:o(()=>[s("machinable.Interface")]),_:1}),s(" class.")]),F,a("p",null,[s("Specifically, to instantiate an interface (e.g. "),A,s(") we can leverage the "),l(n,null,{default:o(()=>[s("machinable.get")]),_:1}),s(" function, which takes a class as the first argument and optional constructor arguments.")]),d,a("p",null,[s("What is happening here is that "),l(n,{caption:"get()"},{default:o(()=>[s("machinable.get")]),_:1}),s(" automatically searches the storage for an interface of type "),C,s(" with a "),u,s(" of "),h,s(". If such an instance has not been committed yet (like when initially running the code), a new instance with this configuration will be returned. But if such an instance has previously been committed, it will simply be reloaded.")]),m,a("p",null,[s("While machinable automatically commits crucial information about the interface, you can use "),l(n,null,{default:o(()=>[s("machinable.Interface.save_file")]),_:1}),s(" and "),l(n,null,{default:o(()=>[s("machinable.Interface.load_file")]),_:1}),s(" to easily store and retrieve additional custom data in different file formats:")]),f,a("p",null,[s("This may be useful to save and restore some custom state of the interface. Furthermore, you are free to implement your own methods to persist data by writing and reading from the interface's "),l(n,{caption:"local_directory()"},{default:o(()=>[s("machinable.Interface.local_directory")]),_:1}),s(":")]),g])}const S=t(i,[["render",_]]);export{k as __pageData,S as default};
diff --git a/assets/guide_introduction.md.56946a6b.js b/assets/guide_introduction.md.619bab14.js
similarity index 97%
rename from assets/guide_introduction.md.56946a6b.js
rename to assets/guide_introduction.md.619bab14.js
index c0120540..bdbb884c 100644
--- a/assets/guide_introduction.md.56946a6b.js
+++ b/assets/guide_introduction.md.619bab14.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,O as l}from"./chunks/framework.62020867.js";const C=JSON.parse('{"title":"Introduction","description":"","frontmatter":{},"headers":[],"relativePath":"guide/introduction.md","filePath":"guide/introduction.md"}'),o={name:"guide/introduction.md"},p=l(`Introduction
What is machinable?
machinable is a Python API for research code. It provides an object-oriented skeleton that helps you develop and experiment in a unified interface while handling tedious housekeeping behind the scenes.
The key idea is to unify the running of code and the retrieval of produced results in one abstraction. A detailed discussion of this approach can be found in the about section, but for now, here is a minimal example that illustrates the idea.
- Write some code
pythonfrom random import random
+import{_ as s,o as a,c as n,O as l}from"./chunks/framework.62020867.js";const C=JSON.parse('{"title":"Introduction","description":"","frontmatter":{},"headers":[],"relativePath":"guide/introduction.md","filePath":"guide/introduction.md"}'),o={name:"guide/introduction.md"},p=l(`Introduction
What is machinable?
machinable is a Python API for research code. It provides an object-oriented skeleton that helps you develop and experiment in a unified interface while handling tedious housekeeping behind the scenes.
The key idea is to unify the running of code and the retrieval of produced results in one abstraction. A detailed discussion of this approach can be found in the about section, but for now, here is a minimal example that illustrates the idea.
- Write some code
pythonfrom random import random
from pydantic import BaseModel, Field
@@ -26,7 +26,7 @@ import{_ as s,o as a,c as n,O as l}from"./chunks/framework.62020867.js";const C=
print(
f"After {self.config.samples} samples, "
f"PI is approximately {self.load_file('result.json')['pi']}."
- )
- Run and inspect it using a unified abstraction
pythonfrom machinable import get
+ )
- Run and inspect it using a unified abstraction
pythonfrom machinable import get
# Imports component in \`montecarlo.py\` with samples=150;
# if an component with this configuration exists, it
diff --git a/assets/guide_introduction.md.56946a6b.lean.js b/assets/guide_introduction.md.619bab14.lean.js
similarity index 100%
rename from assets/guide_introduction.md.56946a6b.lean.js
rename to assets/guide_introduction.md.619bab14.lean.js
diff --git a/examples/aimstack-storage/index.html b/examples/aimstack-storage/index.html
index 0672b20c..33f4dfdb 100644
--- a/examples/aimstack-storage/index.html
+++ b/examples/aimstack-storage/index.html
@@ -11,7 +11,7 @@
-
+
@@ -28,7 +28,7 @@
get("aimstack", {"repo": "./path/to/aim-repo"}).__enter__()
-# your code
Source
pyfrom typing import List, Optional
+# your code
Source
pyfrom typing import List, Optional
import os
@@ -84,7 +84,7 @@
for k, v in interface.__model__.model_dump().items():
run[k] = v
-