Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/skills/observability/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Hamilton UI is a web-based dashboard for:
### 1. Install Hamilton with UI Support

```bash
pip install "sf-hamilton[sdk,ui]"
pip install "apache-hamilton[sdk,ui]"
```

### 2. Start the Hamilton UI
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

--- PR TEMPLATE INSTRUCTIONS (1) ---

Looking to submit a Apache Hamilton Dataflow to the sf-hamilton-contrib module? If so go the the `Preview` tab and select the appropriate sub-template:
* [sf-hamilton-contrib template](?expand=1&template=HAMILTON_CONTRIB_PR_TEMPLATE.md)
Looking to submit a Apache Hamilton Dataflow to the apache-hamilton-contrib module? If so go the the `Preview` tab and select the appropriate sub-template:
* [apache-hamilton-contrib template](?expand=1&template=HAMILTON_CONTRIB_PR_TEMPLATE.md)

Else, if not, please remove this block of text.

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/contrib-auto-build-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
publish-to-pypi:
runs-on: ubuntu-latest
# Specifying a GitHub environment is optional, but strongly encouraged
environment: sf-hamilton-contrib-publishing-environment
environment: apache-hamilton-contrib-publishing-environment
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
Expand Down
23 changes: 6 additions & 17 deletions .github/workflows/docusaurus-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 1000
# 👇 Build steps
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
Expand All @@ -51,19 +50,14 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 20.x
cache: yarn
# The action defaults to search for the dependency file
# (package-lock.json or yarn.lock) in the repository root, and uses
# its hash as a part of the cache key.
# https://github.com/actions/setup-node#caching-packages-dependencies
cache: npm
cache-dependency-path: "./contrib/docs/package-lock.json"
- name: Install dependencies
working-directory: contrib/docs
run: yarn install --frozen-lockfile --non-interactive
run: npm ci
- name: Build
working-directory: contrib/docs
run: yarn build
# 👆 Build steps
run: npm run build
deploy:
if: ${{ github.ref == 'refs/heads/main' }}
environment:
Expand Down Expand Up @@ -92,19 +86,14 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 20.x
cache: yarn
# The action defaults to search for the dependency file
# (package-lock.json or yarn.lock) in the repository root, and uses
# its hash as a part of the cache key.
# https://github.com/actions/setup-node#caching-packages-dependencies
cache: npm
cache-dependency-path: "./contrib/docs/package-lock.json"
- name: Install dependencies
working-directory: contrib/docs
run: yarn install --frozen-lockfile --non-interactive
run: npm ci
- name: Build
working-directory: contrib/docs
run: yarn build
# 👆 Build steps
run: npm run build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/hamilton-ui-build-and-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ jobs:
- name: Install jq
run: sudo apt-get update && sudo apt-get install -y jq

- name: Check latest version of sf-hamilton-ui
- name: Check latest version of apache-hamilton-ui
id: check_version
run: |
response=$(curl -s https://pypi.org/pypi/sf-hamilton-ui/json)
response=$(curl -s https://pypi.org/pypi/apache-hamilton-ui/json)
version=$(echo "$response" | jq -r '.info.version')
echo "latest_version=$version" >> $GITHUB_ENV

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ under the License.
</a><a href="https://www.python.org/downloads/" target="_blank">
<img src="https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13%20|%203.14-blue.svg" alt="Python supported"/>
</a>
<a href="https://pypi.org/project/sf-hamilton/" target="_blank">
<img src="https://badge.fury.io/py/sf-hamilton.svg" alt="PyPi Version"/>
<a href="https://pypi.org/project/apache-hamilton/" target="_blank">
<img src="https://badge.fury.io/py/apache-hamilton.svg" alt="PyPi Version"/>
</a>
<a href="https://pepy.tech/project/sf-hamilton" target="_blank">
<img src="https://pepy.tech/badge/sf-hamilton" alt="Total Downloads"/>
<a href="https://pepy.tech/project/apache-hamilton" target="_blank">
<img src="https://pepy.tech/badge/apache-hamilton" alt="Total Downloads"/>
</a>
<a href="https://pepy.tech/project/sf-hamilton" target="_blank">
<img src="https://static.pepy.tech/badge/sf-hamilton/month" alt="Total Monthly Downloads"/>
<a href="https://pepy.tech/project/apache-hamilton" target="_blank">
<img src="https://static.pepy.tech/badge/apache-hamilton/month" alt="Total Monthly Downloads"/>
</a>
<br/>
<a href="https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g" target="_blank">
Expand Down Expand Up @@ -73,13 +73,13 @@ Apache Hamilton brings modularity and structure to any Python application moving
Apache Hamilton supports Python 3.8+. We include the optional `visualization` dependency to display our Apache Hamilton DAG. For visualizations, [Graphviz](https://graphviz.org/download/) needs to be installed on your system separately.

```bash
pip install "sf-hamilton[visualization]"
pip install "apache-hamilton[visualization]"
```

To use the Apache Hamilton UI, install the `ui` and `sdk` dependencies.

```bash
pip install "sf-hamilton[ui,sdk]"
pip install "apache-hamilton[ui,sdk]"
```

To try Apache Hamilton in the browser, visit [www.tryhamilton.dev](https://www.tryhamilton.dev/?utm_source=README)
Expand Down
4 changes: 2 additions & 2 deletions contrib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ under the License.
>
> While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Here you'll find documentation about the sf-hamilton-contrib package that curates a collection of Apache Hamilton Dataflows that are
Here you'll find documentation about the apache-hamilton-contrib package that curates a collection of Apache Hamilton Dataflows that are
ready to be used in your own projects. They are user-contributed and maintained, with
the goal of making it easier for you to get started with Apache Hamilton.

Expand All @@ -47,7 +47,7 @@ production purposes as you can version-lock your dependencies.
To install the package, run:

```bash
pip install sf-hamilton-contrib --upgrade
pip install apache-hamilton-contrib --upgrade
```

Once installed, you can import the dataflows as follows.
Expand Down
4 changes: 2 additions & 2 deletions contrib/docs/compile_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def dataflows_with_everything(

### Use published library version
```bash
pip install sf-hamilton-contrib --upgrade # make sure you have the latest
pip install apache-hamilton-contrib --upgrade # make sure you have the latest
```

import example2 from '!!raw-loader!./example2.py';
Expand Down Expand Up @@ -226,7 +226,7 @@ def dataflows_with_everything(

### Use published library version
```bash
pip install sf-hamilton-contrib --upgrade # make sure you have the latest
pip install apache-hamilton-contrib --upgrade # make sure you have the latest
```

import example2 from '!!raw-loader!./example2.py';
Expand Down
4 changes: 2 additions & 2 deletions contrib/docs/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ There are two methods to get access to dataflows presented here.
Assumptions:

1. You are familiar with Apache Hamilton and have it installed. If not, take
[15 minutes to learn Apache Hamilton in your browser](https://www.tryhamilton.dev/) and then `pip install sf-hamilton` to get started.
[15 minutes to learn Apache Hamilton in your browser](https://www.tryhamilton.dev/) and then `pip install apache-hamilton` to get started.
Come back here when you're ready to use Apache Hamilton.
2. You have the requisite python dependencies installed on your system.
You'll get import errors if you don't. Don't know what you need? Scroll to the bottom of a dataflow to find the requirements. We're working on convenience functions to help!
Expand Down Expand Up @@ -85,7 +85,7 @@ production purposes as you can version-lock your dependencies.
To install the package, run:

```bash
pip install sf-hamilton-contrib --upgrade
pip install apache-hamilton-contrib --upgrade
```

Once installed, you can import the dataflows as follows.
Expand Down
2 changes: 1 addition & 1 deletion contrib/docs/src/components/example_code.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dr = driver.Driver({}, text_summarization)
`;

export const example2 = `from hamilton import driver
# pip install sf-hamilton-contrib==0.0.1rc1
# pip install apache-hamilton-contrib==0.0.1rc1
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revert this one?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm maybe we just fix forward...

from hamilton.contrib.user.zilto import text_summarization
dr = driver.Driver({}, text_summarization)
# use the driver`;
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apache-hamilton[dask]
# optionally install Ray, or Dask, or both
apache-hamilton[ray]
apache-hamilton[visualization]
langchain
langchain-core
sf-hamilton[dask]
# optionally install Ray, or Dask, or both
sf-hamilton[ray]
sf-hamilton[visualization]
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
apache-hamilton
numpy
scipy
sf-hamilton
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
apache-hamilton
numpy
openai
pandas
pandera
plotly
requests
scikit-learn
sf-hamilton
tenacity
torch
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
absl-py
apache-hamilton
datasets
evaluate
numpy
pandas
peft
rouge-score
scikit-learn
sf-hamilton
torch
tqdm
transformers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apache-hamilton[visualization]
lancedb
numpy
pyarrow
sf-hamilton[visualization]
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apache-hamilton[visualization]
beautifulsoup4
lxml
requests
sf-hamilton[visualization]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apache-hamilton[visualization]
numpy
optuna
pandas
scikit-learn
sf-hamilton[visualization]
xgboost
2 changes: 1 addition & 1 deletion contrib/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sf-hamilton
apache-hamilton
2 changes: 1 addition & 1 deletion contrib/scripts/version_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
CURRENT_VERSION = ".".join(map(str, VERSION))

# Replace 'your-package-name' with your actual package name on PyPI
response = requests.get("https://pypi.org/pypi/sf-hamilton-contrib/json")
response = requests.get("https://pypi.org/pypi/apache-hamilton-contrib/json")
data = response.json()
pypi_version = data["info"]["version"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ under the License.

# Install Python dependencies

Install the ``sf-hamilton`` and the visualization dependencies in your Python environment
Install the ``apache-hamilton`` and the visualization dependencies in your Python environment

``pip install sf-hamilton[lsp]``
``pip install apache-hamilton[lsp]``
4 changes: 2 additions & 2 deletions dev_tools/vscode_extension/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ const checkPythonDependencies = (pythonPath: string) => {
}

function installDependenciesMessage(pythonPath: string) {
let installLSP = "Install sf-hamilton[lsp]"
let installLSP = "Install apache-hamilton[lsp]"

vscode.window.showInformationMessage("Missing the Hamilton language server.", installLSP)
.then(selection => {
if (selection === installLSP) {
execSync(`${pythonPath} -m pip install 'sf-hamilton-lsp'`)
execSync(`${pythonPath} -m pip install 'apache-hamilton-lsp'`)
vscode.commands.executeCommand("workbench.action.reloadWindow")
}
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ ETL Recipe

#. Write Hamilton functions & `“driver”` code.
#. Publish your Hamilton functions in a package, or import via other means (e.g. checkout a repository & include in python path).
#. Include `sf-hamilton` as a python dependency
#. Include `apache-hamilton` as a python dependency
#. Have your ETL system execute your “driver” code.
#. Profit.
4 changes: 2 additions & 2 deletions docs/concepts/function-modifiers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ The next snippet checks if the returned Series is of type ``np.int32``, which is
pandera support
~~~~~~~~~~~~~~~

Apache Hamilton has a pandera plugin for data validation that you can install with ``pip install sf-hamilton[pandera]``. Then, you can pass a pandera schema (for DataFrame or Series) to ``@check_output(schema=...)``.
Apache Hamilton has a pandera plugin for data validation that you can install with ``pip install apache-hamilton[pandera]``. Then, you can pass a pandera schema (for DataFrame or Series) to ``@check_output(schema=...)``.


pydantic support
~~~~~~~~~~~~~~~~

Apache Hamilton also supports data validation of pydantic models, which can be enabled with ``pip install sf-hamilton[pydantic]``. With pydantic installed, you can pass any subclass of the pydantic base model to ``@check_output(model=...)``. Pydantic validation is performed in strict mode, meaning that raw values will not be coerced to the model's types. For more information on strict mode see the `pydantic docs <https://docs.pydantic.dev/latest/concepts/strict_mode/>`_.
Apache Hamilton also supports data validation of pydantic models, which can be enabled with ``pip install apache-hamilton[pydantic]``. With pydantic installed, you can pass any subclass of the pydantic base model to ``@check_output(model=...)``. Pydantic validation is performed in strict mode, meaning that raw values will not be coerced to the model's types. For more information on strict mode see the `pydantic docs <https://docs.pydantic.dev/latest/concepts/strict_mode/>`_.


Split node output into *n* nodes
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
# check if the current commit is tagged as a release (vX.Y.Z) and set the version
GIT_TAG_OUTPUT = subprocess.check_output(["git", "tag", "--points-at", "HEAD"])
current_tag = GIT_TAG_OUTPUT.decode().strip()
if re.match(r"^sf-hamilton-(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", current_tag):
if re.match(r"^apache-hamilton-(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", current_tag):
version = current_tag
else:
version = "latest"
Expand Down
8 changes: 4 additions & 4 deletions docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ For help with python/pip/managing virtual environments see the [python docs](htt

## Installing with pip

Apache Hamilton is published on [pypi](https://pypi.org/project/sf-hamilton/) under ``sf-hamilton``. To install, run:
Apache Hamilton is published on [pypi](https://pypi.org/project/apache-hamilton/) under ``apache-hamilton``. To install, run:

`pip install sf-hamilton`
`pip install apache-hamilton`

To use the DAG visualization functionality, instead install with

`pip install sf-hamilton[visualization]`
`pip install apache-hamilton[visualization]`

*Note: for visualization you may additionally need to install graphviz externally -- see*
[graphviz](https://graphviz.org/download/) *for instructions on the correct way for your
Expand All @@ -47,7 +47,7 @@ operating system.*

Apache Hamilton is also available on conda if you prefer:

`conda install -c hamilton-opensource sf-hamilton`
`conda install -c hamilton-opensource apache-hamilton`

## Installing from source

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/your-first-dataflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ To actually run the dataflow, we'll need to write :doc:`a driver <../concepts/dr
]
# let's create the dataframe!
df = dr.execute(output_columns, inputs=initial_columns)
# `pip install sf-hamilton[visualization]` earlier you can also do
# `pip install apache-hamilton[visualization]` earlier you can also do
# dr.visualize_execution(output_columns,'./my_dag.png', {})
print(df)

Expand Down
4 changes: 2 additions & 2 deletions docs/hamilton-ui/ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To run the hamilton UI in local mode, you can do the following:

.. code-block:: bash

pip install "sf-hamilton[ui,sdk]"
pip install "apache-hamilton[ui,sdk]"
hamilton ui
# python -m hamilton.cli.__main__ ui # on windows

Expand Down Expand Up @@ -148,7 +148,7 @@ First, install the SDK:

.. code-block:: bash

pip install "sf-hamilton[sdk]"
pip install "apache-hamilton[sdk]"

Then, navigate to the project page (dashboard/projects), in the running UI, and click the green ``+ New DAG`` button.

Expand Down
4 changes: 2 additions & 2 deletions docs/hamilton-vscode/language_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ You can also manually install the language server in your Python environment via

.. code:: shell

pip install "sf-hamilton[lsp]"
pip install "apache-hamilton[lsp]"


Developers
----------

If you want to dig in the internals of the language server and integrate it with another IDE, you can find the source code in the ``dev tools/`` section of the `Apache Hamilton GitHub repository <https://github.com/apache/hamilton/tree/main/dev_tools/lsp>`_. It is also directly available on PyPi at `sf-hamilton-lsp <https://pypi.org/project/sf-hamilton-lsp/>`_.
If you want to dig in the internals of the language server and integrate it with another IDE, you can find the source code in the ``dev tools/`` section of the `Apache Hamilton GitHub repository <https://github.com/apache/hamilton/tree/main/dev_tools/lsp>`_. It is also directly available on PyPi at `apache-hamilton-lsp <https://pypi.org/project/apache-hamilton-lsp/>`_.

Note that the package name is ``hamilton_lsp`` when used directly via Python code.
Loading
Loading