Learn how to setup your project to use the SDK.

Setup


## Coniugis erat carmen capillis

Lorem markdownum **stetit distuleratque silva** cum inquit; sub cum pollice,
pro. Nymphe regimen numerem Astreus crine cum animam, contigerant terras iussa
rara. Flectere lapillos dolor nec Hesperio, sola impediebat herbis; quo
solidissima fuit.

> Ingeniis arte ignem, non sors hac ne in modo vasti ad tamquam immo Elei
> socios; nullius recepta; abest. Cum hoc aestus nocens? Annum iam, hunc unda
> misit, ignavi aevum. Me maerenti gaudia; de mihi frondes: reprensa posco:
> Achivae. Sed loqui quo umquam in et lassa: per erat.

Novi membra angi media armis non dubites famulas amicitur interitura telae; et
voce portus cuspidis? Tulisset ut haec una amoris mirum! Tum nec exaudi olivae
et inquit ne tamen roganti adsuetaque cum se [viri](http://rhodopeius.com/), ire
imago utrimque ratos bracchia.

## Missa liquidas in tepido ne facit

Mihi illius et illa, terras Cadmus [patres quas](http://erat-ubi.io/fore.html),
alta. Loquiturque verba ossibus; satis spectat **fallis**, terra Attis tempora.
Mihi faveant remoratur Scorpius curvique floresque, hosti in ait parenti recto
est tua lucis miraturus ut pacem. Callida arma vincant legi hoc ullam **postquam
corpore candor**. Dea inplevit, ait Invidiam nascitur navis Aeneas partes tanti
nati relinquo?

```
nui_engine = enterprise;
shift(topology_kibibyte.ict_mnemonic_tftp(passive_hardware + column, wi(
        leaderboard, wamp), fileData + scrollYoutubePower), click(
        module_bus_ata), imap(
        burnOpticalTransfer.characterMemoryMeta.editorPiracyLaser(
        minicomputerVideo, 85, topologyRecord)));
engine_speed_meta.trinitronIsaSlashdot += scalableCycle;
```

Pars dapibus, amplexus urnam: remisit veniente adplicor in inque. **Sceptra** et
**si lacrimasque** admonitu qui hausit longum contigerant neve, ut limina
cedere. Abantiades fictos, amat inque Aglauros at sub age, Prytaninque.

Comaeque dorso; octavo annum moventem sed; lignum regere in summa; vina erat,
contra. Res ignoscas admovet **functi rediturum** ignea idque deferri, ferrumque
et! Frustraque tam modo Macareus terrarumque adhuc, morae haec Acmona, prima
agros iuvenes noctem, umbra, fratrum.


Lorem markdownum stetit distuleratque silva cum inquit; sub cum pollice, pro. Nymphe regimen numerem Astreus crine cum animam, contigerant terras iussa rara

Lorem ipsum dolor sit amet


## Sub ceris patet magna crimen tumulumque ferre

Lorem markdownum Tyrios; illa dulci, superba. Anaphen temporis lassant, sonus
qui eritque nota **lenita**, qui usus imperio cervum! Velo pictis, merito est
dextrasque murra corpora habet deque **cedunt**. Id *currus uberior maduere*
honore distendens fuerat clivum *portas tegitur Cerberei* bis, promissae?

> Quem vidit hoc, illa: deorum nec, quis huius! Armaque natalis mortale;
> Herculeis consuetas praecedentem fuit sum in quaeque?

Deus heros postquam, hoc vestem *est lacubus*, ego pietas vires? Pennis nec
iacuere forte, in aeratas decerpserat iuvenesque exilio suam *spernimus domus*:
boum? Dat qua non et putat; sciat sit fera Alcathoen **longas**.

Sunt tristi imitamina; [graves quoniam](http://vicimus-sed.com/tangit.html)
septenis; senex quantum dederant [deus](http://necmens.org/tamen-cernitis),
prospexit. Ingenti venti optes poscentem tremor oblitus regna fratri et, si vidi
iam quemque maior tempore lacertis. Ferox vestes admonitu et ritus,
[petentia](http://www.inpleverunt.io/maeoniosarmis) fuit perdidimus enixa;
terruit nec.

## Intus referre pone

Concidis genus, si diu totidem Bacchi murmurat. Felix si Aegaeo faciemque unde.
Potuisset flores; tuque dicit adit vertice thalamique, interdum es solio harenas
tendebant, mandere me euntis.

> Pars sunt ruunt, ulla animosque nihil dixerat, attulit prodamne fata inponere
> rerum dolendi collaque tegmine [mihi novas](http://aliud.org/at.html);
> interea? Eadem et illum nives rogant ruricolam Amor *capillis sua* mella; ipso
> consulat [undis](http://iam.io/longi-quoque.html). Inponi contentus has litis
> Mnemonides Stygio [marmoreis](http://www.cerebrum.net/miserarum-statuit)
> spectas Ausoniae ut pietas vel ad sceleratae.

Non verticibusque canis, *vellera* trepidantibus vicina anser inter mihi. Messis
Achilles rursusque Ossaeae. [Protervis cantu
flammiferas](http://in.io/phaethonperque.aspx) pectora toris sororum frontem
demugitaeque deserit. *Sit ad* Odrysius digna manusque fama dixerat, senectus
pollicita.

```
data += dv_smtp_reciprocal;
ripcording_paper_contextual = 25;
surge_native.internal(sip_drag.motion_card_kindle(
        input_streaming_impression, android_language - icann_dynamic),
        lanHertz, wirelessSpeakers(daw, card_hibernate_archive) + w *
        jre_data_rj);
if (trackball(2, gifMediaCodec(fpu), cell_personal_motion +
        server_fpu_cycle)) {
    systemWins = -3;
    jfsThirdWheel = 2;
} else {
    gif += gbpsDnsNetwork;
}
handle_uml_wrap.party_pppoe_proxy(windows, perl, ppiUgcAnd.contextual(
        station_tablet_development(systrayJsp, remote), default_raw_payload,
        cgi_document(dpi_dsl)));
```

Causa aevumque exposcere forte valet loco latitans fides. Per prima *aetheris
hunc*, utrumque edita **rorantesque bimembres**, a sua vel.


Lorem markdownum Tyrios; illa dulci, superba. Anaphen temporis lassant, sonus qui eritque nota lenita, qui usus imperio cervum

Tua magna radice et suis

Get Started


## Why Ogre.run was created?

The motivation behind it is the realization that, despite all the amazing tools
available today like [Docker](https://www.docker.com/),
[Conda](https://docs.conda.io/en/latest/), and [PyPi](https://pypi.org/),
AI and machine-learning builders still struggle to make their code
(or somebody else's) run out-of-the-box in any machine (Figure 1).

![Figure 1](/assets/images/docs/reproducibility.png "Figure 1")
_Figure 1 - Reproducibility is not a solved problem: builders still struggle to run code out-of-the-box in different machines and environments_

Who hasn't tried to run code out of a GitHub repository, following the author's
instructions, and was faced with some sort of inconsistency of packages/libraries?
And despite the author's efforts to quickly fix those issues, the truth is that
often we hear the same old phrase:

>
> "But it runs in my machine..." ¯\\\_(ツ)_/¯
>

This is especially true for developers building machine-learning solutions in Python:

\- Most of them are scientists/developers who want to quickly assemble a
prototype or a minimum viable product (MVP).

\- Those people aren’t rewarded for writing a complete documentation. Making
Dockerfiles, bash scripts, README files, or even a pip requirements file doesn’t
rank at the top of their priorities.

\- This is a natural result of the continuing popularization of coding: a lot of
builders today -- particularly scientists -- did not have the chance to learn the
best software-engineering and DevOps practices, but this doesn't stop them from
building useful and groundbreaking applications.

We want to support this growing community by providing a tool that enables
developers to focus on code only, i.e., no need for environment definition,
and allows for 3rd parties to run code out-of-the-box, without the need to
spend hours patching it and overcoming undocumented issues.

Ogre is the result of several years learning how scientists and developers
build and share their ideas. We believe it can be incredibly helpful to dev
teams, tech leads, architects, and CTOs whose job is quickly implement ideas
that will eventually make their way into product. It is especially handy to
scientists who want to share code for their papers and academics-turned-entrepreneurs
who usually know how to code their ideas but struggle to find the best way to deploy
them.

## User flow

The typical Ogre.run user flow is represented in Figure 2.
There are two ways of using it:

\- Via a web user interface (UI) in the form of a browser extension

\- Via a Command-Line Interface (CLI) to be used from the terminal

![Figure 2](/assets/images/docs/user_flow.png)
_Figure 2: The typical Ogre user flow. The steps in green represent
the use of the UI; The steps in blue are concerned with the use of
the CLI._

While the browser extension allows for deploying coding environments with a
few clicks, the CLI offers a customized experience where the user has the freedom
to set different parameters. To demonstrate these capabilities, we will go through
the “get started” where we feature the use of the UI. Information on how to the set
up and use the Ogre.run CLI is provided is provided in a separate section.


Ogre is a simple tool to share code and the computational environment where it was designed.

Introduction


Ogre can be used in two ways: either via a Chrome extension
or via a command-line interface (CLI).

## System Requirements

* For the UI/Chrome extension
    * Google Chrome version 111.0.5563.64 or later
* For the CLI
    * Tested on Ubuntu 20.04/22.04, Mac OS Ventura 13.2.1
    * Python 3.8+
    * Docker 20.10+

## Install the Chrome Extension

Head to [*_Chrome Web Store: Ogre.run_*](https://chrome.google.com/webstore/detail/ogrerun/mpfngkffdahoijgoeggoomjfipkjakcc) and install the extension.

![Chrome Store](/assets/images/posts/store.png "Getting Started")

## Install the CLI

Currently, the CLI is provided only for *enterprise-license* customers. But
*pro-license* customers can purchase it as an add-on to their current
subscription.

After the purchase of an enterprise license, we will provide you with
access to a python wheel (.whl), which can be installed as follows
(parameters username and password will be provided):

```bash
pip install https://get.ogre.run/wheels/ogre_run-<version>-py3-none-any.whl
```

Check if it was successfully installed by typing

```bash
ogre --help
```


Installation


## Using the Ogre Chrome Extension

Start your journey by following the steps in this tutorial
published in our blog:

> [Deploying your first environment](/blog/tutorials/getting-started)

The tutorial above delivers you a fully-functional environment, containing
all the python dependencies necessary to run your code.

The environment is currently based on a Jupyter Lab interface (a VS Code interface
in currently in beta test and will be available soon). It looks like this:

![Jupyter Lab Environment](/assets/images/docs/environment_jupyterlab.png "jupyterlab")
_Figure 1: The Ogre environment, based on Jupyter Lab._

As in any Jupyter Lab-based application, you can access the code base, run terminal
commands, create notebooks etc. **What sets Ogre appart is that it automatically identifies
and installs the python dependencies necessary to run your code.**

> Developers can rely on Ogre to build a clean coding and
runtime environment, containing all the python dependencies, isolated from the host's
environment, that guarantees their code will run.

## Using the Ogre CLI

The CLI enables the user to customize how ogre builds and deploys the environment.
It enables the user to:

* Modify specific deployment parameters that are not accessible from the extension

* Deploy local projects, i.e., source code stored in a local folder, directly in the
Ogre.run cloud. This is very handy for professionals who want to expose their project
immediatelly without the need to create a repository on GitHub or GitLab.

### Basic usage

After [installation](/docs/install), one can simply go

### Create a config file

This example will show how one can quickly create a fully functional environment for a public repository (repo) on GitHub. We will be using the following repos:

\- _Ogarantia/tensorflow-attention_ - [https://github.com/Ogarantia/tensorflow-attention](https://github.com/Ogarantia/tensorflow-attention): simple example of the attention mechanism using Tensorflow. It consists of a single jupyter notebook that shows how to train and deploy a neural network built with the attention mechanism.

\- _andrewssobral/llama-webapp_ - [https://github.com/andrewssobral/llama-webapp](https://github.com/andrewssobral/llama-webapp): Gradio web interface to interact with Meta’s LLaMA models.


Let Ogre create a fully-functional environment to run your code out of the box.

Your first environment

Get started with the platform and learn how to use it.

Getting Started


Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?


Lorem ipsum dolor sit amet, consectetur adipiscing elit

Learn how to manage your billing information and view your invoices.

Billing


## Fecerat avis invenio mentis

Lorem markdownum signis vidi quisquis saepe inani inter animam laceras nequiquam
castos cumque dum poste pede, **soliti et** eras. Cornua utendum. Ne dignus
opacae? Moles percussis, redimitus equi quercus haurit perque *aras*; humo!
Digessit Famemque membris vestrum [sua adveniens](http://erit.net/luctus.php)
deserta, et me cum cum dicuntur et ignes.

    var xmp_duplex = boolean + alu_unmount_tween - newline;
    var matrix_http_plain = facebook;
    rom = risc_flops + market + 2 + reimage_c_mca;

## Parilesque duae meritis

Suum spes medio faciunt miserarum artisque. Honor amplectique crescunt saepius
cavis esse saepe laetabile modo. Fontis relinquit titulum est victa mundi!

## Orbem dare

More cingo concipit cumque armenta. Secuta quare profundi damni erigimur effugit
facta ipsa, videt videt. Conantem et **campos animos usquam** ut munus erat
audito, e!

> Talia ponit corpora Philemon. Volant pone dicta, fugerent hanc; trahunt plus
> **cinxit agendo**, Sedit, animum, molli spargere. Perterrita et bella Tiresia
> tanta auctor, colatur **nigro** externa. Stamina nunc bis *longeque* cornua.

## Cantat sequentes et illi opertos Cycno

Per inque Pallade cuspide errabat. Est dolor excitus ultorem avertere, numero et
Minos pater flamine, ictu tune Phylius.

Ditem est qui Scythicis erubuit suae, qui nunc tacito aequare auras. Suas erat
cubitoque esse, volventem quae, fera tinxi villo ita. Addit hic sine at orbe ut
sanesque intravit pudore nullisque Canens, ait aut. Parabat Pittheia Pan cibus
et perque inquit grave suae coniunx cura matris undaeque et stagni et.


Subscription

Chrome Extension

Ogre.run allows you to generate an environment on the go using our Chrome extension.

"use strict";
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = {
    a: "a",
    code: "code",
    em: "em",
    h2: "h2",
    img: "img",
    li: "li",
    p: "p",
    pre: "pre",
    span: "span",
    ul: "ul",
    ...props.components
  };
  return _jsxs(_Fragment, {
    children: [_jsx(_components.p, {
      children: "Ogre can be used in two ways: either via a Chrome extension\nor via a command-line interface (CLI)."
    }), "\n", _jsxs(_components.h2, {
      id: "system-requirements",
      children: [_jsx(_components.a, {
        "aria-hidden": "true",
        tabIndex: "-1",
        href: "#system-requirements",
        children: _jsx(_components.span, {
          className: "icon icon-link"
        })
      }), "System Requirements"]
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsxs(_components.li, {
        children: ["For the UI/Chrome extension", "\n", _jsxs(_components.ul, {
          children: ["\n", _jsx(_components.li, {
            children: "Google Chrome version 111.0.5563.64 or later"
          }), "\n"]
        }), "\n"]
      }), "\n", _jsxs(_components.li, {
        children: ["For the CLI", "\n", _jsxs(_components.ul, {
          children: ["\n", _jsx(_components.li, {
            children: "Tested on Ubuntu 20.04/22.04, Mac OS Ventura 13.2.1"
          }), "\n", _jsx(_components.li, {
            children: "Python 3.8+"
          }), "\n", _jsx(_components.li, {
            children: "Docker 20.10+"
          }), "\n"]
        }), "\n"]
      }), "\n"]
    }), "\n", _jsxs(_components.h2, {
      id: "install-the-chrome-extension",
      children: [_jsx(_components.a, {
        "aria-hidden": "true",
        tabIndex: "-1",
        href: "#install-the-chrome-extension",
        children: _jsx(_components.span, {
          className: "icon icon-link"
        })
      }), "Install the Chrome Extension"]
    }), "\n", _jsxs(_components.p, {
      children: ["Head to ", _jsx(_components.a, {
        href: "https://chrome.google.com/webstore/detail/ogrerun/mpfngkffdahoijgoeggoomjfipkjakcc",
        children: _jsx(_components.em, {
          children: _jsx(_components.em, {
            children: "Chrome Web Store: Ogre.run"
          })
        })
      }), " and install the extension."]
    }), "\n", _jsx(_components.p, {
      children: _jsx(_components.img, {
        src: "/assets/images/posts/store.png",
        alt: "Chrome Store",
        title: "Getting Started"
      })
    }), "\n", _jsxs(_components.h2, {
      id: "install-the-cli",
      children: [_jsx(_components.a, {
        "aria-hidden": "true",
        tabIndex: "-1",
        href: "#install-the-cli",
        children: _jsx(_components.span, {
          className: "icon icon-link"
        })
      }), "Install the CLI"]
    }), "\n", _jsxs(_components.p, {
      children: ["Currently, the CLI is provided only for ", _jsx(_components.em, {
        children: "enterprise-license"
      }), " customers. But\n", _jsx(_components.em, {
        children: "pro-license"
      }), " customers can purchase it as an add-on to their current\nsubscription."]
    }), "\n", _jsx(_components.p, {
      children: "After the purchase of an enterprise license, we will provide you with\naccess to a python wheel (.whl), which can be installed as follows\n(parameters username and password will be provided):"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "language-bash",
        children: "pip install https://get.ogre.run/wheels/ogre_run-<version>-py3-none-any.whl\n"
      })
    }), "\n", _jsx(_components.p, {
      children: "Check if it was successfully installed by typing"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "language-bash",
        children: "ogre --help\n"
      })
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = props.components || ({});
  return MDXLayout ? _jsx(MDXLayout, {
    ...props,
    children: _jsx(_createMdxContent, {
      ...props
    })
  }) : _createMdxContent(props);
}
return {
  default: MDXContent
};


Setup

Get Started

Getting Started

Billing

Chrome Extension

Installation

Installing Ogre in your system.

System Requirements

Install the Chrome Extension

Install the CLI

Table of Contents