Skip to content

Commit 245816c

Browse files
Fixed installation (#3)
* fix init * Updated authors list * Fixed installation
1 parent 1fb7720 commit 245816c

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,29 @@ This library is brought to you by the GridFM team to train, finetune and interac
1212

1313
# Installation
1414

15-
Create a python virtual environment and install the requirements
15+
You can install `gridfm-graphkit` directly from PyPI:
16+
17+
```bash
18+
pip install gridfm-graphkit
19+
```
20+
21+
To contribute or develop locally, clone the repository and install in editable mode:
22+
1623
```bash
1724
git clone git@github.com:gridfm/gridfm-graphkit.git
1825
cd gridfm-graphkit
1926
python -m venv venv
2027
source venv/bin/activate
21-
pip install .
28+
pip install -e .
2229
```
2330

24-
Install the package in editable mode during development phase:
31+
For documentation generation and unit testing, install with the optional `dev` and `test` extras:
2532

2633
```bash
2734
pip install -e .[dev,test]
2835
```
2936

37+
3038
# gridfm-graphkit CLI
3139

3240
An interface to train, fine-tune, and evaluate GridFM models using configurable YAML files and MLflow tracking.

docs/install/installation.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
1-
Create a python virtual environment and install the requirements
1+
You can install `gridfm-graphkit` directly from PyPI:
2+
3+
```bash
4+
pip install gridfm-graphkit
5+
```
6+
7+
---
8+
9+
## Development Setup
10+
11+
To contribute or develop locally, clone the repository and install in editable mode:
12+
213
```bash
314
git clone git@github.com:gridfm/gridfm-graphkit.git
415
cd gridfm-graphkit
516
python -m venv venv
617
source venv/bin/activate
7-
pip install .
18+
pip install -e .
819
```
920

10-
Install the package in editable mode during development phase:
21+
For documentation generation and unit testing, install with the optional `dev` and `test` extras:
1122

1223
```bash
1324
pip install -e .[dev,test]

docs/quick_start/quick_start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GridFM CLI
1+
# CLI commands
22

33
An interface to train, fine-tune, and evaluate GridFM models using configurable YAML files and MLflow tracking.
44

0 commit comments

Comments
 (0)