Skip to content

Update BUILDING.md (grammar changes) #1523

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
Jun 13, 2022
Merged

Update BUILDING.md (grammar changes) #1523

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1b4135
Update BUILDING.md
ArjunSharda Jun 12, 2022
cd2413d
Merge branch 'main' into patch-1
ArjunSharda Jun 13, 2022
06135b6
Merge branch 'main' into patch-1
TobyRoseman Jun 13, 2022
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
8 changes: 4 additions & 4 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Building from Source
====================

This page describes building Core ML Tools (coremltools) from the source repository.
This page describes how to build Core ML Tools (coremltools) from the source repository.

## Requirements

Expand All @@ -24,7 +24,7 @@ Follow these steps:

3. Run the [test.sh](scripts/test.sh) script to test the build.

**Under the hood**: If an Anaconda or Miniconda environment doesn't already exists or is not up-to-date, the `build.sh` script automatically runs the [`env_create.sh`](scripts/env_create.sh) script to create the environment. It then uses [`env_activate.sh`](scripts/env_activate.sh) to activate the environment and set up the appropriate version of Python. The new environment is located at `<repo root>/coremltoos/envs` and is named after the `py` parameter. For example, a development environment with py 3.7 is named `coremltools-dev-py37`.
**Under the hood**: If an Anaconda or Miniconda environment doesn't already exist or is not up-to-date, the `build.sh` script automatically runs the [`env_create.sh`](scripts/env_create.sh) script to create the environment. It then uses [`env_activate.sh`](scripts/env_activate.sh) to activate the environment and set up the appropriate version of Python. The new environment is located at `<repo root>/coremltoos/envs` and is named after the `py` parameter. For example, a development environment with py 3.7 is named `coremltools-dev-py37`.


## Build targets
Expand Down Expand Up @@ -53,8 +53,8 @@ For more information, see the following:

* Core ML Tools [README](README.md) file for this repository
* [Release Notes](https://github.com/apple/coremltools/releases/) for the current release and previous releases
* [Guides and examples](https://coremltools.readme.io/) with installation and troubleshooting
* [Guides and examples](https://coremltools.readme.io/) with installation and troubleshooting help
* [API Reference](https://apple.github.io/coremltools/index.html)
* [Core ML Specification](https://apple.github.io/coremltools/mlmodel/index.html)
* [Contribution Guidelines](CONTRIBUTING.md) for reporting issues and making requests
* [Contribution Guidelines](CONTRIBUTING.md) for reporting issues and making pull requests